@ckeditor/ckeditor5-list
Version:
Ordered and unordered lists feature to CKEditor 5.
83 lines (82 loc) • 3.18 kB
JavaScript
/**
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/
/**
* @module list/todolist/checktodolistcommand
*/
import { Command } from 'ckeditor5/src/core.js';
import { getAllListItemBlocks } from '../list/utils/model.js';
/**
* The check to-do command.
*
* The command is registered by the {@link module:list/todolist/todolistediting~TodoListEditing} as
* the `checkTodoList` editor command.
*/
export default class CheckTodoListCommand extends Command {
/**
* @inheritDoc
*/
constructor(editor) {
super(editor);
// Refresh command before executing to be sure all values are up to date.
// It is needed when selection has changed before command execution, in the same change block.
this.on('execute', () => {
this.refresh();
}, { priority: 'highest' });
}
/**
* Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
*/
refresh() {
const selectedElements = this._getSelectedItems();
this.value = this._getValue(selectedElements);
this.isEnabled = !!selectedElements.length;
}
/**
* Executes the command.
*
* @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply
* the attribute. Otherwise, the command will remove the attribute. If not set, the command will look for its current
* value to decide what it should do.
*/
execute(options = {}) {
this.editor.model.change(writer => {
const selectedElements = this._getSelectedItems();
const value = (options.forceValue === undefined) ? !this._getValue(selectedElements) : options.forceValue;
for (const element of selectedElements) {
if (value) {
writer.setAttribute('todoListChecked', true, element);
}
else {
writer.removeAttribute('todoListChecked', element);
}
}
});
}
/**
* Returns a value for the command.
*/
_getValue(selectedElements) {
return selectedElements.every(element => element.getAttribute('todoListChecked'));
}
/**
* Gets all to-do list items selected by the {@link module:engine/model/selection~Selection}.
*/
_getSelectedItems() {
const model = this.editor.model;
const schema = model.schema;
const selectionRange = model.document.selection.getFirstRange();
const startElement = selectionRange.start.parent;
const elements = [];
if (schema.checkAttribute(startElement, 'todoListChecked')) {
elements.push(...getAllListItemBlocks(startElement));
}
for (const item of selectionRange.getItems({ shallow: true })) {
if (schema.checkAttribute(item, 'todoListChecked') && !elements.includes(item)) {
elements.push(...getAllListItemBlocks(item));
}
}
return elements;
}
}