/
liststylecommand.js
117 lines (100 loc) · 3.05 KB
/
liststylecommand.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/**
* @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module list/liststylecommand
*/
import Command from '@ckeditor/ckeditor5-core/src/command';
import { getSiblingNodes } from './utils';
/**
* The list style command. It is used by the {@link module:list/liststyle~ListStyle list style feature}.
*
* @extends module:core/command~Command
*/
export default class ListStyleCommand extends Command {
/**
* Creates an instance of the command.
*
* @param {module:core/editor/editor~Editor} editor The editor instance.
* @param {String} defaultType The list type that will be used by default if the value was not specified during
* the command execution.
*/
constructor( editor, defaultType ) {
super( editor );
/**
* The default type of the list style.
*
* @protected
* @member {String}
*/
this._defaultType = defaultType;
}
/**
* @inheritDoc
*/
refresh() {
this.value = this._getValue();
this.isEnabled = this._checkEnabled();
}
/**
* Executes the command.
*
* @param {Object} options
* @param {String|null} options.type The type of the list style, e.g. `'disc'` or `'square'`. If `null` is specified, the default
* style will be applied.
* @protected
*/
execute( options = {} ) {
const model = this.editor.model;
const document = model.document;
// For all selected blocks find all list items that are being selected
// and update the `listStyle` attribute in those lists.
let listItems = [ ...document.selection.getSelectedBlocks() ]
.filter( element => element.is( 'element', 'listItem' ) )
.map( element => {
const position = model.change( writer => writer.createPositionAt( element, 0 ) );
return [
...getSiblingNodes( position, 'backward' ),
...getSiblingNodes( position, 'forward' )
];
} )
.flat();
// Since `getSelectedBlocks()` can return items that belong to the same list, and
// `getSiblingNodes()` returns the entire list, we need to remove duplicated items.
listItems = [ ...new Set( listItems ) ];
if ( !listItems.length ) {
return;
}
model.change( writer => {
for ( const item of listItems ) {
writer.setAttribute( 'listStyle', options.type || this._defaultType, item );
}
} );
}
/**
* Checks the command's {@link #value}.
*
* @private
* @returns {String|null} The current value.
*/
_getValue() {
const listItem = this.editor.model.document.selection.getFirstPosition().parent;
if ( listItem && listItem.is( 'element', 'listItem' ) ) {
return listItem.getAttribute( 'listStyle' );
}
return null;
}
/**
* Checks whether the command can be enabled in the current context.
*
* @private
* @returns {Boolean} Whether the command should be enabled.
*/
_checkEnabled() {
const editor = this.editor;
const numberedList = editor.commands.get( 'numberedList' );
const bulletedList = editor.commands.get( 'bulletedList' );
return numberedList.isEnabled || bulletedList.isEnabled;
}
}