@ckeditor/ckeditor5-list 40.0.0 → 40.2.0

package/src/tododocumentlist.d.ts

@@ -1,27 +1,27 @@
-/**
- * @license Copyright (c) 2003-2023, 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
- */
-import TodoDocumentListEditing from './tododocumentlist/tododocumentlistediting';
-import TodoListUI from './todolist/todolistui';
-import { Plugin } from 'ckeditor5/src/core';
-import '../theme/todolist.css';
-/**
- * The to-do list feature.
- *
- * This is a "glue" plugin that loads the {@link module:list/todolist/todolistediting~TodoListEditing to-do list editing feature}
- * and the {@link module:list/todolist/todolistui~TodoListUI to-do list UI feature}.
- */
-export default class TodoDocumentList extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TodoDocumentListEditing, typeof TodoListUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TodoDocumentList";
-}
+/**
+ * @license Copyright (c) 2003-2023, 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
+ */
+import TodoDocumentListEditing from './tododocumentlist/tododocumentlistediting';
+import TodoListUI from './todolist/todolistui';
+import { Plugin } from 'ckeditor5/src/core';
+import '../theme/todolist.css';
+/**
+ * The to-do list feature.
+ *
+ * This is a "glue" plugin that loads the {@link module:list/todolist/todolistediting~TodoListEditing to-do list editing feature}
+ * and the {@link module:list/todolist/todolistui~TodoListUI to-do list UI feature}.
+ */
+export default class TodoDocumentList extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TodoDocumentListEditing, typeof TodoListUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TodoDocumentList";
+}

package/src/tododocumentlist.js

@@ -1,31 +1,31 @@
-/**
- * @license Copyright (c) 2003-2023, 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
- */
-import TodoDocumentListEditing from './tododocumentlist/tododocumentlistediting';
-import TodoListUI from './todolist/todolistui';
-import { Plugin } from 'ckeditor5/src/core';
-import '../theme/todolist.css';
-/**
- * The to-do list feature.
- *
- * This is a "glue" plugin that loads the {@link module:list/todolist/todolistediting~TodoListEditing to-do list editing feature}
- * and the {@link module:list/todolist/todolistui~TodoListUI to-do list UI feature}.
- */
-export default class TodoDocumentList extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [TodoDocumentListEditing, TodoListUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'TodoDocumentList';
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, 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
+ */
+import TodoDocumentListEditing from './tododocumentlist/tododocumentlistediting';
+import TodoListUI from './todolist/todolistui';
+import { Plugin } from 'ckeditor5/src/core';
+import '../theme/todolist.css';
+/**
+ * The to-do list feature.
+ *
+ * This is a "glue" plugin that loads the {@link module:list/todolist/todolistediting~TodoListEditing to-do list editing feature}
+ * and the {@link module:list/todolist/todolistui~TodoListUI to-do list UI feature}.
+ */
+export default class TodoDocumentList extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [TodoDocumentListEditing, TodoListUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TodoDocumentList';
+    }
+}

package/src/todolist/checktodolistcommand.d.ts

@@ -1,52 +1,52 @@
-/**
- * @license Copyright (c) 2003-2023, 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';
-/**
- * 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.
- */
-export default class CheckTodoListCommand extends Command {
-    /**
-     * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
-     *
-     * @observable
-     * @readonly
-     */
-    value: boolean;
-    /**
-     * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
-     *
-     * @internal
-     */
-    _selectedElements: Array<Element>;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * 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.
-     *
-     * @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?: {
-        forceValue?: boolean;
-    }): void;
-}
+/**
+ * @license Copyright (c) 2003-2023, 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';
+/**
+ * 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.
+ */
+export default class CheckTodoListCommand extends Command {
+    /**
+     * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
+     *
+     * @observable
+     * @readonly
+     */
+    value: boolean;
+    /**
+     * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
+     *
+     * @internal
+     */
+    _selectedElements: Array<Element>;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * 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.
+     *
+     * @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?: {
+        forceValue?: boolean;
+    }): void;
+}

package/src/todolist/checktodolistcommand.js

@@ -1,76 +1,76 @@
-/**
- * @license Copyright (c) 2003-2023, 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';
-/**
- * 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.
- */
-export default class CheckTodoListCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    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', () => {
-            this.refresh();
-        }, { priority: 'highest' });
-    }
-    /**
-     * 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;
-    }
-    /**
-     * 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 => {
-            for (const element of this._selectedElements) {
-                const value = (options.forceValue === undefined) ? !this.value : options.forceValue;
-                if (value) {
-                    writer.setAttribute(attributeKey, true, element);
-                }
-                else {
-                    writer.removeAttribute(attributeKey, element);
-                }
-            }
-        });
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, 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';
+/**
+ * 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.
+ */
+export default class CheckTodoListCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    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', () => {
+            this.refresh();
+        }, { priority: 'highest' });
+    }
+    /**
+     * 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;
+    }
+    /**
+     * 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 => {
+            for (const element of this._selectedElements) {
+                const value = (options.forceValue === undefined) ? !this.value : options.forceValue;
+                if (value) {
+                    writer.setAttribute(attributeKey, true, element);
+                }
+                else {
+                    writer.removeAttribute(attributeKey, element);
+                }
+            }
+        });
+    }
+}

package/src/todolist/todolistconverters.d.ts

@@ -1,82 +1,82 @@
-/**
- * @license Copyright (c) 2003-2023, 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/todolistconverters
- */
-import type { DowncastAttributeEvent, DowncastInsertEvent, Element, MapperModelToViewPositionEvent, Model, UpcastElementEvent, View } from 'ckeditor5/src/engine';
-import { type GetCallback } from 'ckeditor5/src/utils';
-/**
- * A model-to-view converter for the `listItem` model element insertion.
- *
- * It converts the `listItem` model element to an unordered list with a {@link module:engine/view/uielement~UIElement checkbox element}
- * at the beginning of each list item. It also merges the list with surrounding lists (if available).
- *
- * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
- *
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
- * @param model Model instance.
- * @param onCheckboxChecked Callback function.
- * @returns Returns a conversion callback.
- */
-export declare function modelViewInsertion(model: Model, onCheckboxChecked: (element: Element) => void): GetCallback<DowncastInsertEvent<Element>>;
-/**
- * A model-to-view converter for the `listItem` model element insertion.
- *
- * It is used by {@link module:engine/controller/datacontroller~DataController}.
- *
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
- * @param model Model instance.
- * @returns Returns a conversion callback.
- */
-export declare function dataModelViewInsertion(model: Model): GetCallback<DowncastInsertEvent<Element>>;
-/**
- * A view-to-model converter for the checkbox element inside a view list item.
- *
- * It changes the `listType` of the model `listItem` to a `todo` value.
- * When a view checkbox element is marked as checked, an additional `todoListChecked="true"` attribute is added to the model item.
- *
- * It is used by {@link module:engine/controller/datacontroller~DataController}.
- *
- * @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
- */
-export declare const dataViewModelCheckmarkInsertion: GetCallback<UpcastElementEvent>;
-/**
- * A model-to-view converter for the `listType` attribute change on the `listItem` model element.
- *
- * This change means that the `<li>` element parent changes to `<ul class="todo-list">` and a
- * {@link module:engine/view/uielement~UIElement checkbox UI element} is added at the beginning
- * of the list item element (or vice versa).
- *
- * This converter is preceded by {@link module:list/list/converters~modelViewChangeType} and followed by
- * {@link module:list/list/converters~modelViewMergeAfterChangeType} to handle splitting and merging surrounding lists of the same type.
- *
- * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
- *
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
- * @param onCheckedChange Callback fired after clicking the checkbox UI element.
- * @param view Editing view controller.
- * @returns Returns a conversion callback.
- */
-export declare function modelViewChangeType(onCheckedChange: (element: Element) => void, view: View): GetCallback<DowncastAttributeEvent<Element>>;
-/**
- * A model-to-view converter for the `todoListChecked` attribute change on the `listItem` model element.
- *
- * It marks the {@link module:engine/view/uielement~UIElement checkbox UI element} as checked.
- *
- * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
- *
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
- * @param onCheckedChange Callback fired after clicking the checkbox UI element.
- * @returns Returns a conversion callback.
- */
-export declare function modelViewChangeChecked(onCheckedChange: (element: Element) => void): GetCallback<DowncastAttributeEvent<Element>>;
-/**
- * A model-to-view position at zero offset mapper.
- *
- * This helper ensures that position inside todo-list in the view is mapped after the checkbox.
- *
- * It only handles the position at the beginning of a list item as other positions are properly mapped be the default mapper.
- */
-export declare function mapModelToViewPosition(view: View): GetCallback<MapperModelToViewPositionEvent>;
+/**
+ * @license Copyright (c) 2003-2023, 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/todolistconverters
+ */
+import type { DowncastAttributeEvent, DowncastInsertEvent, Element, MapperModelToViewPositionEvent, Model, UpcastElementEvent, View } from 'ckeditor5/src/engine';
+import { type GetCallback } from 'ckeditor5/src/utils';
+/**
+ * A model-to-view converter for the `listItem` model element insertion.
+ *
+ * It converts the `listItem` model element to an unordered list with a {@link module:engine/view/uielement~UIElement checkbox element}
+ * at the beginning of each list item. It also merges the list with surrounding lists (if available).
+ *
+ * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
+ * @param model Model instance.
+ * @param onCheckboxChecked Callback function.
+ * @returns Returns a conversion callback.
+ */
+export declare function modelViewInsertion(model: Model, onCheckboxChecked: (element: Element) => void): GetCallback<DowncastInsertEvent<Element>>;
+/**
+ * A model-to-view converter for the `listItem` model element insertion.
+ *
+ * It is used by {@link module:engine/controller/datacontroller~DataController}.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
+ * @param model Model instance.
+ * @returns Returns a conversion callback.
+ */
+export declare function dataModelViewInsertion(model: Model): GetCallback<DowncastInsertEvent<Element>>;
+/**
+ * A view-to-model converter for the checkbox element inside a view list item.
+ *
+ * It changes the `listType` of the model `listItem` to a `todo` value.
+ * When a view checkbox element is marked as checked, an additional `todoListChecked="true"` attribute is added to the model item.
+ *
+ * It is used by {@link module:engine/controller/datacontroller~DataController}.
+ *
+ * @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
+ */
+export declare const dataViewModelCheckmarkInsertion: GetCallback<UpcastElementEvent>;
+/**
+ * A model-to-view converter for the `listType` attribute change on the `listItem` model element.
+ *
+ * This change means that the `<li>` element parent changes to `<ul class="todo-list">` and a
+ * {@link module:engine/view/uielement~UIElement checkbox UI element} is added at the beginning
+ * of the list item element (or vice versa).
+ *
+ * This converter is preceded by {@link module:list/list/converters~modelViewChangeType} and followed by
+ * {@link module:list/list/converters~modelViewMergeAfterChangeType} to handle splitting and merging surrounding lists of the same type.
+ *
+ * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
+ * @param onCheckedChange Callback fired after clicking the checkbox UI element.
+ * @param view Editing view controller.
+ * @returns Returns a conversion callback.
+ */
+export declare function modelViewChangeType(onCheckedChange: (element: Element) => void, view: View): GetCallback<DowncastAttributeEvent<Element>>;
+/**
+ * A model-to-view converter for the `todoListChecked` attribute change on the `listItem` model element.
+ *
+ * It marks the {@link module:engine/view/uielement~UIElement checkbox UI element} as checked.
+ *
+ * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
+ * @param onCheckedChange Callback fired after clicking the checkbox UI element.
+ * @returns Returns a conversion callback.
+ */
+export declare function modelViewChangeChecked(onCheckedChange: (element: Element) => void): GetCallback<DowncastAttributeEvent<Element>>;
+/**
+ * A model-to-view position at zero offset mapper.
+ *
+ * This helper ensures that position inside todo-list in the view is mapped after the checkbox.
+ *
+ * It only handles the position at the beginning of a list item as other positions are properly mapped be the default mapper.
+ */
+export declare function mapModelToViewPosition(view: View): GetCallback<MapperModelToViewPositionEvent>;