@ckeditor/ckeditor5-list
Version:
Ordered and unordered lists feature to CKEditor 5.
61 lines (60 loc) • 2.12 kB
JavaScript
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module list/listproperties/liststartcommand
*/
import { Command } from 'ckeditor5/src/core.js';
import { first } from 'ckeditor5/src/utils.js';
import { expandListBlocksToCompleteList, isListItemBlock, isNumberedListType } from '../list/utils/model.js';
/**
* The list start index command. It changes the `listStart` attribute of the selected list items,
* letting the user to choose the starting point of an ordered list.
* It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
*/
export default class ListStartCommand extends Command {
/**
* @inheritDoc
*/
refresh() {
const value = this._getValue();
this.value = value;
this.isEnabled = value != null;
}
/**
* Executes the command.
*
* @fires execute
* @param options.startIndex The list start index.
*/
execute({ startIndex = 1 } = {}) {
const model = this.editor.model;
const document = model.document;
let blocks = Array.from(document.selection.getSelectedBlocks())
.filter(block => isListItemBlock(block) &&
isNumberedListType(block.getAttribute('listType')));
blocks = expandListBlocksToCompleteList(blocks);
model.change(writer => {
for (const block of blocks) {
writer.setAttribute('listStart', startIndex >= 0 ? startIndex : 1, block);
}
});
}
/**
* Checks the command's {@link #value}.
*
* @returns The current value.
*/
_getValue() {
const model = this.editor.model;
const document = model.document;
const block = first(document.selection.getSelectedBlocks());
if (block &&
isListItemBlock(block) &&
isNumberedListType(block.getAttribute('listType'))) {
return block.getAttribute('listStart');
}
return null;
}
}