@ckeditor/ckeditor5-list 39.0.1 → 40.0.0

package/src/todolist/todolistconverters.js

@@ -1,260 +1,260 @@
-/**
- * @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
- */
-import { createElement } from 'ckeditor5/src/utils';
-import { generateLiInUl, injectViewList, positionAfterUiElements, findNestedList } from '../list/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 function modelViewInsertion(model, onCheckboxChecked) {
-    return (evt, data, conversionApi) => {
-        const consumable = conversionApi.consumable;
-        if (!consumable.test(data.item, 'insert') ||
-            !consumable.test(data.item, 'attribute:listType') ||
-            !consumable.test(data.item, 'attribute:listIndent')) {
-            return;
-        }
-        if (data.item.getAttribute('listType') != 'todo') {
-            return;
-        }
-        const modelItem = data.item;
-        consumable.consume(modelItem, 'insert');
-        consumable.consume(modelItem, 'attribute:listType');
-        consumable.consume(modelItem, 'attribute:listIndent');
-        consumable.consume(modelItem, 'attribute:todoListChecked');
-        const viewWriter = conversionApi.writer;
-        const viewItem = generateLiInUl(modelItem, conversionApi);
-        const isChecked = !!modelItem.getAttribute('todoListChecked');
-        const checkmarkElement = createCheckmarkElement(modelItem, viewWriter, isChecked, onCheckboxChecked);
-        const span = viewWriter.createContainerElement('span', {
-            class: 'todo-list__label__description'
-        });
-        viewWriter.addClass('todo-list', viewItem.parent);
-        viewWriter.insert(viewWriter.createPositionAt(viewItem, 0), checkmarkElement);
-        viewWriter.insert(viewWriter.createPositionAfter(checkmarkElement), span);
-        injectViewList(modelItem, viewItem, conversionApi, model);
-    };
-}
-/**
- * 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 function dataModelViewInsertion(model) {
-    return (evt, data, conversionApi) => {
-        const consumable = conversionApi.consumable;
-        if (!consumable.test(data.item, 'insert') ||
-            !consumable.test(data.item, 'attribute:listType') ||
-            !consumable.test(data.item, 'attribute:listIndent')) {
-            return;
-        }
-        if (data.item.getAttribute('listType') != 'todo') {
-            return;
-        }
-        const modelItem = data.item;
-        consumable.consume(modelItem, 'insert');
-        consumable.consume(modelItem, 'attribute:listType');
-        consumable.consume(modelItem, 'attribute:listIndent');
-        consumable.consume(modelItem, 'attribute:todoListChecked');
-        const viewWriter = conversionApi.writer;
-        const viewItem = generateLiInUl(modelItem, conversionApi);
-        viewWriter.addClass('todo-list', viewItem.parent);
-        const label = viewWriter.createContainerElement('label', {
-            class: 'todo-list__label'
-        });
-        const checkbox = viewWriter.createEmptyElement('input', {
-            type: 'checkbox',
-            disabled: 'disabled'
-        });
-        const span = viewWriter.createContainerElement('span', {
-            class: 'todo-list__label__description'
-        });
-        if (modelItem.getAttribute('todoListChecked')) {
-            viewWriter.setAttribute('checked', 'checked', checkbox);
-        }
-        viewWriter.insert(viewWriter.createPositionAt(viewItem, 0), label);
-        viewWriter.insert(viewWriter.createPositionAt(label, 0), checkbox);
-        viewWriter.insert(viewWriter.createPositionAfter(checkbox), span);
-        injectViewList(modelItem, viewItem, conversionApi, model);
-    };
-}
-/**
- * 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 const dataViewModelCheckmarkInsertion = (evt, data, conversionApi) => {
-    const modelCursor = data.modelCursor;
-    const modelItem = modelCursor.parent;
-    const viewItem = data.viewItem;
-    if (viewItem.getAttribute('type') != 'checkbox' || modelItem.name != 'listItem' || !modelCursor.isAtStart) {
-        return;
-    }
-    if (!conversionApi.consumable.consume(viewItem, { name: true })) {
-        return;
-    }
-    const writer = conversionApi.writer;
-    writer.setAttribute('listType', 'todo', modelItem);
-    if (data.viewItem.hasAttribute('checked')) {
-        writer.setAttribute('todoListChecked', true, modelItem);
-    }
-    data.modelRange = writer.createRange(modelCursor);
-};
-/**
- * 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 function modelViewChangeType(onCheckedChange, view) {
-    return (evt, data, conversionApi) => {
-        if (!conversionApi.consumable.consume(data.item, evt.name)) {
-            return;
-        }
-        const viewItem = conversionApi.mapper.toViewElement(data.item);
-        const viewWriter = conversionApi.writer;
-        const labelElement = findLabel(viewItem, view);
-        if (data.attributeNewValue == 'todo') {
-            const isChecked = !!data.item.getAttribute('todoListChecked');
-            const checkmarkElement = createCheckmarkElement(data.item, viewWriter, isChecked, onCheckedChange);
-            const span = viewWriter.createContainerElement('span', {
-                class: 'todo-list__label__description'
-            });
-            const itemRange = viewWriter.createRangeIn(viewItem);
-            const nestedList = findNestedList(viewItem);
-            const descriptionStart = positionAfterUiElements(itemRange.start);
-            const descriptionEnd = nestedList ? viewWriter.createPositionBefore(nestedList) : itemRange.end;
-            const descriptionRange = viewWriter.createRange(descriptionStart, descriptionEnd);
-            viewWriter.addClass('todo-list', viewItem.parent);
-            viewWriter.move(descriptionRange, viewWriter.createPositionAt(span, 0));
-            viewWriter.insert(viewWriter.createPositionAt(viewItem, 0), checkmarkElement);
-            viewWriter.insert(viewWriter.createPositionAfter(checkmarkElement), span);
-        }
-        else if (data.attributeOldValue == 'todo') {
-            const descriptionSpan = findDescription(viewItem, view);
-            viewWriter.removeClass('todo-list', viewItem.parent);
-            viewWriter.remove(labelElement);
-            viewWriter.move(viewWriter.createRangeIn(descriptionSpan), viewWriter.createPositionBefore(descriptionSpan));
-            viewWriter.remove(descriptionSpan);
-        }
-    };
-}
-/**
- * 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 function modelViewChangeChecked(onCheckedChange) {
-    return (evt, data, conversionApi) => {
-        // Do not convert `todoListChecked` attribute when to-do list item has changed to other list item.
-        // This attribute will be removed by the model post fixer.
-        if (data.item.getAttribute('listType') != 'todo') {
-            return;
-        }
-        if (!conversionApi.consumable.consume(data.item, 'attribute:todoListChecked')) {
-            return;
-        }
-        const { mapper, writer: viewWriter } = conversionApi;
-        const isChecked = !!data.item.getAttribute('todoListChecked');
-        const viewItem = mapper.toViewElement(data.item);
-        // Because of m -> v position mapper we can be sure checkbox is always at the beginning.
-        const oldCheckmarkElement = viewItem.getChild(0);
-        const newCheckmarkElement = createCheckmarkElement(data.item, viewWriter, isChecked, onCheckedChange);
-        viewWriter.insert(viewWriter.createPositionAfter(oldCheckmarkElement), newCheckmarkElement);
-        viewWriter.remove(oldCheckmarkElement);
-    };
-}
-/**
- * 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 function mapModelToViewPosition(view) {
-    return (evt, data) => {
-        const modelPosition = data.modelPosition;
-        const parent = modelPosition.parent;
-        if (!parent.is('element', 'listItem') || parent.getAttribute('listType') != 'todo') {
-            return;
-        }
-        const viewLi = data.mapper.toViewElement(parent);
-        const descSpan = findDescription(viewLi, view);
-        if (descSpan) {
-            data.viewPosition = data.mapper.findPositionIn(descSpan, modelPosition.offset);
-        }
-    };
-}
-/**
- * Creates a checkbox UI element.
- */
-function createCheckmarkElement(modelItem, viewWriter, isChecked, onChange) {
-    const uiElement = viewWriter.createUIElement('label', {
-        class: 'todo-list__label',
-        contenteditable: false
-    }, function (domDocument) {
-        const checkbox = createElement(document, 'input', { type: 'checkbox', tabindex: '-1' });
-        if (isChecked) {
-            checkbox.setAttribute('checked', 'checked');
-        }
-        checkbox.addEventListener('change', () => onChange(modelItem));
-        const domElement = this.toDomElement(domDocument);
-        domElement.appendChild(checkbox);
-        return domElement;
-    });
-    return uiElement;
-}
-// Helper method to find label element inside li.
-function findLabel(viewItem, view) {
-    const range = view.createRangeIn(viewItem);
-    for (const value of range) {
-        if (value.item.is('uiElement', 'label')) {
-            return value.item;
-        }
-    }
-}
-function findDescription(viewItem, view) {
-    const range = view.createRangeIn(viewItem);
-    for (const value of range) {
-        if (value.item.is('containerElement', 'span') && value.item.hasClass('todo-list__label__description')) {
-            return value.item;
-        }
-    }
-}
+/**
+ * @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
+ */
+import { createElement } from 'ckeditor5/src/utils';
+import { generateLiInUl, injectViewList, positionAfterUiElements, findNestedList } from '../list/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 function modelViewInsertion(model, onCheckboxChecked) {
+    return (evt, data, conversionApi) => {
+        const consumable = conversionApi.consumable;
+        if (!consumable.test(data.item, 'insert') ||
+            !consumable.test(data.item, 'attribute:listType') ||
+            !consumable.test(data.item, 'attribute:listIndent')) {
+            return;
+        }
+        if (data.item.getAttribute('listType') != 'todo') {
+            return;
+        }
+        const modelItem = data.item;
+        consumable.consume(modelItem, 'insert');
+        consumable.consume(modelItem, 'attribute:listType');
+        consumable.consume(modelItem, 'attribute:listIndent');
+        consumable.consume(modelItem, 'attribute:todoListChecked');
+        const viewWriter = conversionApi.writer;
+        const viewItem = generateLiInUl(modelItem, conversionApi);
+        const isChecked = !!modelItem.getAttribute('todoListChecked');
+        const checkmarkElement = createCheckmarkElement(modelItem, viewWriter, isChecked, onCheckboxChecked);
+        const span = viewWriter.createContainerElement('span', {
+            class: 'todo-list__label__description'
+        });
+        viewWriter.addClass('todo-list', viewItem.parent);
+        viewWriter.insert(viewWriter.createPositionAt(viewItem, 0), checkmarkElement);
+        viewWriter.insert(viewWriter.createPositionAfter(checkmarkElement), span);
+        injectViewList(modelItem, viewItem, conversionApi, model);
+    };
+}
+/**
+ * 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 function dataModelViewInsertion(model) {
+    return (evt, data, conversionApi) => {
+        const consumable = conversionApi.consumable;
+        if (!consumable.test(data.item, 'insert') ||
+            !consumable.test(data.item, 'attribute:listType') ||
+            !consumable.test(data.item, 'attribute:listIndent')) {
+            return;
+        }
+        if (data.item.getAttribute('listType') != 'todo') {
+            return;
+        }
+        const modelItem = data.item;
+        consumable.consume(modelItem, 'insert');
+        consumable.consume(modelItem, 'attribute:listType');
+        consumable.consume(modelItem, 'attribute:listIndent');
+        consumable.consume(modelItem, 'attribute:todoListChecked');
+        const viewWriter = conversionApi.writer;
+        const viewItem = generateLiInUl(modelItem, conversionApi);
+        viewWriter.addClass('todo-list', viewItem.parent);
+        const label = viewWriter.createContainerElement('label', {
+            class: 'todo-list__label'
+        });
+        const checkbox = viewWriter.createEmptyElement('input', {
+            type: 'checkbox',
+            disabled: 'disabled'
+        });
+        const span = viewWriter.createContainerElement('span', {
+            class: 'todo-list__label__description'
+        });
+        if (modelItem.getAttribute('todoListChecked')) {
+            viewWriter.setAttribute('checked', 'checked', checkbox);
+        }
+        viewWriter.insert(viewWriter.createPositionAt(viewItem, 0), label);
+        viewWriter.insert(viewWriter.createPositionAt(label, 0), checkbox);
+        viewWriter.insert(viewWriter.createPositionAfter(checkbox), span);
+        injectViewList(modelItem, viewItem, conversionApi, model);
+    };
+}
+/**
+ * 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 const dataViewModelCheckmarkInsertion = (evt, data, conversionApi) => {
+    const modelCursor = data.modelCursor;
+    const modelItem = modelCursor.parent;
+    const viewItem = data.viewItem;
+    if (viewItem.getAttribute('type') != 'checkbox' || modelItem.name != 'listItem' || !modelCursor.isAtStart) {
+        return;
+    }
+    if (!conversionApi.consumable.consume(viewItem, { name: true })) {
+        return;
+    }
+    const writer = conversionApi.writer;
+    writer.setAttribute('listType', 'todo', modelItem);
+    if (data.viewItem.hasAttribute('checked')) {
+        writer.setAttribute('todoListChecked', true, modelItem);
+    }
+    data.modelRange = writer.createRange(modelCursor);
+};
+/**
+ * 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 function modelViewChangeType(onCheckedChange, view) {
+    return (evt, data, conversionApi) => {
+        if (!conversionApi.consumable.consume(data.item, evt.name)) {
+            return;
+        }
+        const viewItem = conversionApi.mapper.toViewElement(data.item);
+        const viewWriter = conversionApi.writer;
+        const labelElement = findLabel(viewItem, view);
+        if (data.attributeNewValue == 'todo') {
+            const isChecked = !!data.item.getAttribute('todoListChecked');
+            const checkmarkElement = createCheckmarkElement(data.item, viewWriter, isChecked, onCheckedChange);
+            const span = viewWriter.createContainerElement('span', {
+                class: 'todo-list__label__description'
+            });
+            const itemRange = viewWriter.createRangeIn(viewItem);
+            const nestedList = findNestedList(viewItem);
+            const descriptionStart = positionAfterUiElements(itemRange.start);
+            const descriptionEnd = nestedList ? viewWriter.createPositionBefore(nestedList) : itemRange.end;
+            const descriptionRange = viewWriter.createRange(descriptionStart, descriptionEnd);
+            viewWriter.addClass('todo-list', viewItem.parent);
+            viewWriter.move(descriptionRange, viewWriter.createPositionAt(span, 0));
+            viewWriter.insert(viewWriter.createPositionAt(viewItem, 0), checkmarkElement);
+            viewWriter.insert(viewWriter.createPositionAfter(checkmarkElement), span);
+        }
+        else if (data.attributeOldValue == 'todo') {
+            const descriptionSpan = findDescription(viewItem, view);
+            viewWriter.removeClass('todo-list', viewItem.parent);
+            viewWriter.remove(labelElement);
+            viewWriter.move(viewWriter.createRangeIn(descriptionSpan), viewWriter.createPositionBefore(descriptionSpan));
+            viewWriter.remove(descriptionSpan);
+        }
+    };
+}
+/**
+ * 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 function modelViewChangeChecked(onCheckedChange) {
+    return (evt, data, conversionApi) => {
+        // Do not convert `todoListChecked` attribute when to-do list item has changed to other list item.
+        // This attribute will be removed by the model post fixer.
+        if (data.item.getAttribute('listType') != 'todo') {
+            return;
+        }
+        if (!conversionApi.consumable.consume(data.item, 'attribute:todoListChecked')) {
+            return;
+        }
+        const { mapper, writer: viewWriter } = conversionApi;
+        const isChecked = !!data.item.getAttribute('todoListChecked');
+        const viewItem = mapper.toViewElement(data.item);
+        // Because of m -> v position mapper we can be sure checkbox is always at the beginning.
+        const oldCheckmarkElement = viewItem.getChild(0);
+        const newCheckmarkElement = createCheckmarkElement(data.item, viewWriter, isChecked, onCheckedChange);
+        viewWriter.insert(viewWriter.createPositionAfter(oldCheckmarkElement), newCheckmarkElement);
+        viewWriter.remove(oldCheckmarkElement);
+    };
+}
+/**
+ * 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 function mapModelToViewPosition(view) {
+    return (evt, data) => {
+        const modelPosition = data.modelPosition;
+        const parent = modelPosition.parent;
+        if (!parent.is('element', 'listItem') || parent.getAttribute('listType') != 'todo') {
+            return;
+        }
+        const viewLi = data.mapper.toViewElement(parent);
+        const descSpan = findDescription(viewLi, view);
+        if (descSpan) {
+            data.viewPosition = data.mapper.findPositionIn(descSpan, modelPosition.offset);
+        }
+    };
+}
+/**
+ * Creates a checkbox UI element.
+ */
+function createCheckmarkElement(modelItem, viewWriter, isChecked, onChange) {
+    const uiElement = viewWriter.createUIElement('label', {
+        class: 'todo-list__label',
+        contenteditable: false
+    }, function (domDocument) {
+        const checkbox = createElement(document, 'input', { type: 'checkbox', tabindex: '-1' });
+        if (isChecked) {
+            checkbox.setAttribute('checked', 'checked');
+        }
+        checkbox.addEventListener('change', () => onChange(modelItem));
+        const domElement = this.toDomElement(domDocument);
+        domElement.appendChild(checkbox);
+        return domElement;
+    });
+    return uiElement;
+}
+// Helper method to find label element inside li.
+function findLabel(viewItem, view) {
+    const range = view.createRangeIn(viewItem);
+    for (const value of range) {
+        if (value.item.is('uiElement', 'label')) {
+            return value.item;
+        }
+    }
+}
+function findDescription(viewItem, view) {
+    const range = view.createRangeIn(viewItem);
+    for (const value of range) {
+        if (value.item.is('containerElement', 'span') && value.item.hasClass('todo-list__label__description')) {
+            return value.item;
+        }
+    }
+}

package/src/todolist/todolistediting.d.ts

@@ -1,39 +1,39 @@
-/**
- * @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
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ListEditing from '../list/listediting';
-/**
- * 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:
- *
- * - `'todoList'`,
- * - `'checkTodoList'`,
- * - `'todoListCheck'` as an alias for `checkTodoList` command.
- */
-export default class TodoListEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TodoListEditing";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ListEditing];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Handles the checkbox element change, moves the selection to the corresponding model item to make it possible
-     * to toggle the `todoListChecked` attribute using the command, and restores the selection position.
-     *
-     * Some say it's a hack :) Moving the selection only for executing the command on a certain node and restoring it after,
-     * is not a clear solution. We need to design an API for using commands beyond the selection range.
-     * See https://github.com/ckeditor/ckeditor5/issues/1954.
-     */
-    private _handleCheckmarkChange;
-}
+/**
+ * @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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ListEditing from '../list/listediting';
+/**
+ * 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:
+ *
+ * - `'todoList'`,
+ * - `'checkTodoList'`,
+ * - `'todoListCheck'` as an alias for `checkTodoList` command.
+ */
+export default class TodoListEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TodoListEditing";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ListEditing];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Handles the checkbox element change, moves the selection to the corresponding model item to make it possible
+     * to toggle the `todoListChecked` attribute using the command, and restores the selection position.
+     *
+     * Some say it's a hack :) Moving the selection only for executing the command on a certain node and restoring it after,
+     * is not a clear solution. We need to design an API for using commands beyond the selection range.
+     * See https://github.com/ckeditor/ckeditor5/issues/1954.
+     */
+    private _handleCheckmarkChange;
+}