@ckeditor/ckeditor5-list 40.2.0 → 41.0.0

package/src/todolist/checktodolistcommand.d.ts

@@ -1,17 +1,16 @@
 /**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * @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/todolist/checktodolistcommand
  */
-import { Command, type Editor } from 'ckeditor5/src/core';
-import type { Element } from 'ckeditor5/src/engine';
+import { Command, type Editor } from 'ckeditor5/src/core.js';
 /**
  * The check to-do command.
  *
  * The command is registered by the {@link module:list/todolist/todolistediting~TodoListEditing} as
- * the `checkTodoList` editor command and it is also available via aliased `todoListCheck` name.
+ * the `checkTodoList` editor command.
  */
 export default class CheckTodoListCommand extends Command {
     /**
@@ -21,12 +20,6 @@ export default class CheckTodoListCommand extends Command {
      * @readonly
      */
     value: boolean;
-    /**
-     * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
-     *
-     * @internal
-     */
-    _selectedElements: Array<Element>;
     /**
      * @inheritDoc
      */
@@ -35,10 +28,6 @@ export default class CheckTodoListCommand extends Command {
      * Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
      */
     refresh(): void;
-    /**
-     * Gets all to-do list items selected by the {@link module:engine/model/selection~Selection}.
-     */
-    private _getSelectedItems;
     /**
      * Executes the command.
      *
@@ -49,4 +38,12 @@ export default class CheckTodoListCommand extends Command {
     execute(options?: {
         forceValue?: boolean;
     }): void;
+    /**
+     * Returns a value for the command.
+     */
+    private _getValue;
+    /**
+     * Gets all to-do list items selected by the {@link module:engine/model/selection~Selection}.
+     */
+    private _getSelectedItems;
 }

package/src/todolist/checktodolistcommand.js

@@ -1,17 +1,17 @@
 /**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * @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/todolist/checktodolistcommand
  */
-import { Command } from 'ckeditor5/src/core';
-const attributeKey = 'todoListChecked';
+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 and it is also available via aliased `todoListCheck` name.
+ * the `checkTodoList` editor command.
  */
 export default class CheckTodoListCommand extends Command {
     /**
@@ -19,7 +19,6 @@ export default class CheckTodoListCommand extends Command {
      */
     constructor(editor) {
         super(editor);
-        this._selectedElements = [];
         // 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', () => {
@@ -30,28 +29,9 @@ export default class CheckTodoListCommand extends Command {
      * Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
      */
     refresh() {
-        this._selectedElements = this._getSelectedItems();
-        this.value = this._selectedElements.every(element => !!element.getAttribute(attributeKey));
-        this.isEnabled = !!this._selectedElements.length;
-    }
-    /**
-     * 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, attributeKey)) {
-            elements.push(startElement);
-        }
-        for (const item of selectionRange.getItems()) {
-            if (schema.checkAttribute(item, attributeKey) && !elements.includes(item)) {
-                elements.push(item);
-            }
-        }
-        return elements;
+        const selectedElements = this._getSelectedItems();
+        this.value = this._getValue(selectedElements);
+        this.isEnabled = !!selectedElements.length;
     }
     /**
      * Executes the command.
@@ -62,15 +42,41 @@ export default class CheckTodoListCommand extends Command {
      */
     execute(options = {}) {
         this.editor.model.change(writer => {
-            for (const element of this._selectedElements) {
-                const value = (options.forceValue === undefined) ? !this.value : options.forceValue;
+            const selectedElements = this._getSelectedItems();
+            const value = (options.forceValue === undefined) ? !this._getValue(selectedElements) : options.forceValue;
+            for (const element of selectedElements) {
                 if (value) {
-                    writer.setAttribute(attributeKey, true, element);
+                    writer.setAttribute('todoListChecked', true, element);
                 }
                 else {
-                    writer.removeAttribute(attributeKey, element);
+                    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;
+    }
 }

package/src/{tododocumentlist → todolist}/todocheckboxchangeobserver.d.ts

@@ -1,11 +1,11 @@
 /**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * @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/tododocumentlist/todocheckboxchangeobserver
+ * @module list/todolist/todocheckboxchangeobserver
  */
-import { DomEventObserver, type DomEventData } from 'ckeditor5/src/engine';
+import { DomEventObserver, type DomEventData } from 'ckeditor5/src/engine.js';
 /**
  * Observes all to-do list checkboxes state changes.
  *
@@ -25,13 +25,13 @@ export default class TodoCheckboxChangeObserver extends DomEventObserver<'change
 /**
  * Fired when the to-do list checkbox is toggled.
  *
- * Introduced by {@link module:list/tododocumentlist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}.
+ * Introduced by {@link module:list/todolist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}.
  *
  * Note that this event is not available by default. To make it available,
- * {@link module:list/tododocumentlist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}
+ * {@link module:list/todolist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}
  * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
  *
- * @see module:list/tododocumentlist/todocheckboxchangeobserver~TodoCheckboxChangeObserver
+ * @see module:list/todolist/todocheckboxchangeobserver~TodoCheckboxChangeObserver
  * @eventName module:engine/view/document~Document#todoCheckboxChange
  * @param data The event data.
  */

package/src/{tododocumentlist → todolist}/todocheckboxchangeobserver.js

@@ -1,11 +1,11 @@
 /**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * @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/tododocumentlist/todocheckboxchangeobserver
+ * @module list/todolist/todocheckboxchangeobserver
  */
-import { DomEventObserver } from 'ckeditor5/src/engine';
+import { DomEventObserver } from 'ckeditor5/src/engine.js';
 /**
  * Observes all to-do list checkboxes state changes.
  *

package/src/todolist/todolistediting.d.ts

@@ -1,18 +1,17 @@
 /**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
-import { Plugin } from 'ckeditor5/src/core';
-import ListEditing from '../list/listediting';
+import { Plugin } from 'ckeditor5/src/core.js';
+import ListEditing from '../list/listediting.js';
 /**
  * The engine of the to-do list feature. It handles creating, editing and removing to-do lists and their items.
  *
- * It registers the entire functionality of the {@link module:list/list/listediting~ListEditing list editing plugin} and extends
- * it with the commands:
+ * It registers the entire functionality of the {@link module:list/list/listediting~ListEditing list editing plugin}
+ * and extends it with the commands:
  *
  * - `'todoList'`,
  * - `'checkTodoList'`,
- * - `'todoListCheck'` as an alias for `checkTodoList` command.
  */
 export default class TodoListEditing extends Plugin {
     /**