@ckeditor/ckeditor5-list 39.0.2 → 40.1.0

package/ckeditor5-metadata.json

@@ -97,6 +97,7 @@
 			"name": "Document list",
 			"className": "DocumentList",
 			"description": "Implements bulleted and numbered list features. Supports block content inside list elements. Incompatible with the List plugin.",
+			"docs": "features/lists/document-lists.html",
 			"path": "src/documentlist.js",
 			"uiComponents": [
 				{
@@ -122,10 +123,53 @@
 				}
 			]
 		},
+		{
+			"name": "To-do document list",
+			"className": "TodoDocumentList",
+			"description": "Allows for creating a list of interactive checkboxes with labels. It supports all features of document lists so you can nest a to-do list together with bulleted and numbered lists in any combination.",
+			"docs": "features/lists/document-lists.html#to-do-lists",
+			"path": "src/tododocumentlist.js",
+			"requires": [
+				"DocumentList"
+			],
+			"uiComponents": [
+				{
+					"type": "Button",
+					"name": "todoList",
+					"iconPath": "theme/icons/todolist.svg"
+				}
+			],
+			"htmlOutput": [
+				{
+					"elements": "ul",
+					"classes": "todo-list"
+				},
+				{
+					"elements": "li"
+				},
+				{
+					"elements": "label",
+					"classes": [ "todo-list__label", "todo-list__label_without-description" ]
+				},
+				{
+					"elements": "span",
+					"classes": "todo-list__label__description"
+				},
+				{
+					"elements": "input",
+					"attributes": [
+						"checked",
+						"disabled",
+						"type"
+					]
+				}
+			]
+		},
 		{
 			"name": "Document list properties",
 			"className": "DocumentListProperties",
 			"description": "Enables styling the list item markers for both ordered and unordered lists created by the document list plugin. You can choose various types of numerals and letters or visual markers to use with these lists. Also enables setting start index (initial marker value) and list reversal (from ascending to descending) for numbered lists.",
+			"docs": "features/lists/document-lists.html#document-list-properties",
 			"path": "src/documentlistproperties.js",
 			"requires": [
 				"DocumentList"

package/lang/translations/fi.po

@@ -119,7 +119,7 @@ msgstr "Alkaa"
 
 msgctxt "The error message displayed when the numbered list start index input value is invalid."
 msgid "Start index must be greater than 0."
-msgstr "Aloitusindeksi ei saa olla suurempi kuin 0."
+msgstr "Aloitusindeksin pitää olla suurempi kuin 0."
 
 msgctxt "The label of the switch button that reverses the order of the numbered list."
 msgid "Reversed order"

package/lang/translations/pt-br.po

@@ -55,23 +55,23 @@ msgstr "Alternar o estilo de lista decimal"
 
 msgctxt "The ARIA label of the button that toggles the \"decimal with leading zero\" list style."
 msgid "Toggle the decimal with leading zero list style"
-msgstr "Alternar o decimal com estilo de lista zero à esquerda"
+msgstr "Alternar o estilo de lista decimal com zero à esquerda"
 
 msgctxt "The ARIA label of the button that toggles the \"lower–roman\" list style."
 msgid "Toggle the lower–roman list style"
-msgstr "Alternar o estilo de lista romana inferior"
+msgstr "Alternar o estilo de lista romana minúscula"
 
 msgctxt "The ARIA label of the button that toggles the \"upper–roman\" list style."
 msgid "Toggle the upper–roman list style"
-msgstr "Alternar o estilo de lista romana superior"
+msgstr "Alternar o estilo de lista romana maiúscula"
 
 msgctxt "The ARIA label of the button that toggles the \"lower–latin\" list style."
 msgid "Toggle the lower–latin list style"
-msgstr "Alternar o estilo de lista latina inferior"
+msgstr "Alternar o estilo de lista latina minúscula"
 
 msgctxt "The ARIA label of the button that toggles the \"upper–latin\" list style."
 msgid "Toggle the upper–latin list style"
-msgstr "Alternar o estilo de lista latino superior"
+msgstr "Alternar o estilo de lista latino maiúscula"
 
 msgctxt "The tooltip text of the button that toggles the \"disc\" list style."
 msgid "Disc"
@@ -95,19 +95,19 @@ msgstr "Decimal com zero à esquerda"
 
 msgctxt "The tooltip text of the button that toggles the \"lower–roman\" list style."
 msgid "Lower–roman"
-msgstr "Romano inferior"
+msgstr "Romano minúsculo"
 
 msgctxt "The tooltip text of the button that toggles the \"upper–roman\" list style."
 msgid "Upper-roman"
-msgstr "Romano superior"
+msgstr "Romano maiúsculo"
 
 msgctxt "The tooltip text of the button that toggles the \"lower–latin\" list style."
 msgid "Lower-latin"
-msgstr "Latim inferior"
+msgstr "Latim minúsculo"
 
 msgctxt "The tooltip text of the button that toggles the \"upper–latin\" list style."
 msgid "Upper-latin"
-msgstr "Latim superior"
+msgstr "Latim maiúsculo"
 
 msgctxt "The label of the button that toggles the visibility of additional numbered list property UI fields."
 msgid "List properties"
@@ -123,4 +123,4 @@ msgstr "O índice inicial deve ser maior que 0."
 
 msgctxt "The label of the switch button that reverses the order of the numbered list."
 msgid "Reversed order"
-msgstr "Ordem reversa"
+msgstr "Ordem inversa"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-list",
-  "version": "39.0.2",
+  "version": "40.1.0",
   "description": "Ordered and unordered lists feature to CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,8 +12,8 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "39.0.2",
-    "@ckeditor/ckeditor5-ui": "39.0.2"
+    "ckeditor5": "40.1.0",
+    "@ckeditor/ckeditor5-ui": "40.1.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",

package/src/augmentation.d.ts

@@ -2,7 +2,7 @@
  * @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 type { DocumentList, DocumentListEditing, DocumentListProperties, DocumentListPropertiesEditing, DocumentListPropertiesUtils, AdjacentListsSupport, DocumentListUtils, ListConfig, List, ListEditing, ListProperties, ListPropertiesEditing, ListPropertiesUI, ListStyle, ListUI, ListUtils, TodoList, TodoListEditing, TodoListUI, ListCommand, DocumentListCommand, IndentCommand, DocumentListIndentCommand, DocumentListMergeCommand, DocumentListSplitCommand, ListStyleCommand, DocumentListStyleCommand, ListStartCommand, DocumentListStartCommand, ListReversedCommand, DocumentListReversedCommand, CheckTodoListCommand } from '.';
+import type { DocumentList, DocumentListEditing, DocumentListProperties, DocumentListPropertiesEditing, DocumentListPropertiesUtils, AdjacentListsSupport, DocumentListUtils, ListConfig, List, ListEditing, ListProperties, ListPropertiesEditing, ListPropertiesUI, ListStyle, ListUI, ListUtils, TodoList, TodoListEditing, TodoListUI, TodoDocumentList, TodoDocumentListEditing, ListCommand, DocumentListCommand, IndentCommand, DocumentListIndentCommand, DocumentListMergeCommand, DocumentListSplitCommand, ListStyleCommand, DocumentListStyleCommand, ListStartCommand, DocumentListStartCommand, ListReversedCommand, DocumentListReversedCommand, CheckTodoListCommand, CheckTodoDocumentListCommand } from '.';
 declare module '@ckeditor/ckeditor5-core' {
     interface EditorConfig {
         /**
@@ -31,6 +31,8 @@ declare module '@ckeditor/ckeditor5-core' {
         [TodoList.pluginName]: TodoList;
         [TodoListEditing.pluginName]: TodoListEditing;
         [TodoListUI.pluginName]: TodoListUI;
+        [TodoDocumentList.pluginName]: TodoDocumentList;
+        [TodoDocumentListEditing.pluginName]: TodoDocumentListEditing;
     }
     interface CommandsMap {
         numberedList: ListCommand | DocumentListCommand;
@@ -44,7 +46,7 @@ declare module '@ckeditor/ckeditor5-core' {
         listStyle: ListStyleCommand | DocumentListStyleCommand;
         listStart: ListStartCommand | DocumentListStartCommand;
         listReversed: ListReversedCommand | DocumentListReversedCommand;
-        todoList: ListCommand;
-        checkTodoList: CheckTodoListCommand;
+        todoList: ListCommand | DocumentListCommand;
+        checkTodoList: CheckTodoListCommand | CheckTodoDocumentListCommand;
     }
 }

package/src/documentlist/converters.d.ts

@@ -41,7 +41,9 @@ export declare function reconvertItemsOnDataChange(model: Model, editing: Editin
  * @param strategies The strategies.
  * @param model The model.
  */
-export declare function listItemDowncastConverter(attributeNames: Array<string>, strategies: Array<DowncastStrategy>, model: Model): GetCallback<DowncastAttributeEvent<ListElement>>;
+export declare function listItemDowncastConverter(attributeNames: Array<string>, strategies: Array<DowncastStrategy>, model: Model, { dataPipeline }?: {
+    dataPipeline?: boolean;
+}): GetCallback<DowncastAttributeEvent<ListElement>>;
 /**
  * Returns the bogus paragraph view element creator. A bogus paragraph is used if a list item contains only a single block or nested list.
  *

package/src/documentlist/converters.js

@@ -6,7 +6,7 @@
  * @module list/documentlist/converters
  */
 import { UpcastWriter } from 'ckeditor5/src/engine';
-import { getAllListItemBlocks, getListItemBlocks, isListItemBlock, ListItemUid } from './utils/model';
+import { getAllListItemBlocks, getListItemBlocks, isListItemBlock, isFirstBlockOfListItem, ListItemUid } from './utils/model';
 import { createListElement, createListItemElement, getIndent, isListView, isListItemView } from './utils/view';
 import ListWalker, { iterateSiblingListBlocks } from './utils/listwalker';
 import { findAndAddListHeadToMap } from './utils/postfixers';
@@ -26,14 +26,22 @@ export function listItemUpcastConverter() {
         if (!items.length) {
             return;
         }
+        const listItemId = ListItemUid.next();
+        const listIndent = getIndent(data.viewItem);
+        let listType = data.viewItem.parent && data.viewItem.parent.is('element', 'ol') ? 'numbered' : 'bulleted';
+        // Preserve list type if was already set (for example by to-do list feature).
+        const firstItemListType = items[0].getAttribute('listType');
+        if (firstItemListType) {
+            listType = firstItemListType;
+        }
         const attributes = {
-            listItemId: ListItemUid.next(),
-            listIndent: getIndent(data.viewItem),
-            listType: data.viewItem.parent && data.viewItem.parent.is('element', 'ol') ? 'numbered' : 'bulleted'
+            listItemId,
+            listIndent,
+            listType
         };
         for (const item of items) {
             // Set list attributes only on same level items, those nested deeper are already handled by the recursive conversion.
-            if (!isListItemBlock(item)) {
+            if (!item.hasAttribute('listItemId')) {
                 writer.setAttributes(attributes, item);
             }
         }
@@ -111,7 +119,7 @@ export function reconvertItemsOnDataChange(model, editing, attributeNames, docum
                     if (entry.attributeNewValue === null) {
                         findAndAddListHeadToMap(entry.range.start.getShiftedBy(1), itemToListHead);
                         // Check if paragraph should be converted from bogus to plain paragraph.
-                        if (doesItemParagraphRequiresRefresh(item)) {
+                        if (doesItemBlockRequiresRefresh(item)) {
                             itemsToRefresh.push(item);
                         }
                     }
@@ -122,7 +130,7 @@ export function reconvertItemsOnDataChange(model, editing, attributeNames, docum
                 else if (isListItemBlock(item)) {
                     // Some other attribute was changed on the list item,
                     // check if paragraph does not need to be converted to bogus or back.
-                    if (doesItemParagraphRequiresRefresh(item)) {
+                    if (doesItemBlockRequiresRefresh(item)) {
                         itemsToRefresh.push(item);
                     }
                 }
@@ -156,7 +164,7 @@ export function reconvertItemsOnDataChange(model, editing, attributeNames, docum
             for (const block of blocks) {
                 visited.add(block);
                 // Check if bogus vs plain paragraph needs refresh.
-                if (doesItemParagraphRequiresRefresh(block, blocks)) {
+                if (doesItemBlockRequiresRefresh(block, blocks)) {
                     itemsToRefresh.push(block);
                 }
                 // Check if wrapping with UL, OL, LIs needs refresh.
@@ -167,14 +175,21 @@ export function reconvertItemsOnDataChange(model, editing, attributeNames, docum
         }
         return itemsToRefresh;
     }
-    function doesItemParagraphRequiresRefresh(item, blocks) {
-        if (!item.is('element', 'paragraph')) {
-            return false;
-        }
+    function doesItemBlockRequiresRefresh(item, blocks) {
         const viewElement = editing.mapper.toViewElement(item);
         if (!viewElement) {
             return false;
         }
+        const needsRefresh = documentListEditing.fire('checkElement', {
+            modelElement: item,
+            viewElement
+        });
+        if (needsRefresh) {
+            return true;
+        }
+        if (!item.is('element', 'paragraph') && !item.is('element', 'listItem')) {
+            return false;
+        }
         const useBogus = shouldUseBogusParagraph(item, attributeNames, blocks);
         if (useBogus && viewElement.is('element', 'p')) {
             return true;
@@ -225,7 +240,7 @@ export function reconvertItemsOnDataChange(model, editing, attributeNames, docum
  * @param strategies The strategies.
  * @param model The model.
  */
-export function listItemDowncastConverter(attributeNames, strategies, model) {
+export function listItemDowncastConverter(attributeNames, strategies, model, { dataPipeline } = {}) {
     const consumer = createAttributesConsumer(attributeNames);
     return (evt, data, conversionApi) => {
         const { writer, mapper, consumable } = conversionApi;
@@ -240,10 +255,14 @@ export function listItemDowncastConverter(attributeNames, strategies, model) {
         // Use positions mapping instead of mapper.toViewElement( listItem ) to find outermost view element.
         // This is for cases when mapping is using inner view element like in the code blocks (pre > code).
         const viewElement = findMappedViewElement(listItem, mapper, model);
+        // Remove custom item marker.
+        removeCustomMarkerElements(viewElement, writer, mapper);
         // Unwrap element from current list wrappers.
         unwrapListItemBlock(viewElement, writer);
-        // Then wrap them with the new list wrappers.
-        wrapListItemBlock(listItem, writer.createRangeOn(viewElement), strategies, writer);
+        // Insert custom item marker.
+        const viewRange = insertCustomMarkerElements(listItem, viewElement, strategies, writer, { dataPipeline });
+        // Then wrap them with the new list wrappers (UL, OL, LI).
+        wrapListItemBlock(listItem, viewRange, strategies, writer);
     };
 }
 /**
@@ -279,9 +298,74 @@ export function bogusParagraphCreator(attributeNames, { dataPipeline } = {}) {
 export function findMappedViewElement(element, mapper, model) {
     const modelRange = model.createRangeOn(element);
     const viewRange = mapper.toViewRange(modelRange).getTrimmed();
-    return viewRange.getContainedElement();
+    return viewRange.end.nodeBefore;
 }
-// Unwraps all ol, ul, and li attribute elements that are wrapping the provided view element.
+/**
+ * Removes a custom marker elements and item wrappers related to that marker.
+ */
+function removeCustomMarkerElements(viewElement, viewWriter, mapper) {
+    // Remove item wrapper.
+    while (viewElement.parent.is('attributeElement') && viewElement.parent.getCustomProperty('listItemWrapper')) {
+        viewWriter.unwrap(viewWriter.createRangeIn(viewElement.parent), viewElement.parent);
+    }
+    // Remove custom item markers.
+    const viewWalker = viewWriter.createPositionBefore(viewElement).getWalker({ direction: 'backward' });
+    const markersToRemove = [];
+    for (const { item } of viewWalker) {
+        // Walk only over the non-mapped elements between list item blocks.
+        if (item.is('element') && mapper.toModelElement(item)) {
+            break;
+        }
+        if (item.is('element') && item.getCustomProperty('listItemMarker')) {
+            markersToRemove.push(item);
+        }
+    }
+    for (const marker of markersToRemove) {
+        viewWriter.remove(marker);
+    }
+}
+/**
+ * Inserts a custom marker elements and wraps first block of a list item if marker requires it.
+ */
+function insertCustomMarkerElements(listItem, viewElement, strategies, writer, { dataPipeline }) {
+    let viewRange = writer.createRangeOn(viewElement);
+    // Marker can be inserted only before the first block of a list item.
+    if (!isFirstBlockOfListItem(listItem)) {
+        return viewRange;
+    }
+    for (const strategy of strategies) {
+        if (strategy.scope != 'itemMarker') {
+            continue;
+        }
+        // Create the custom marker element and inject it before the first block of the list item.
+        const markerElement = strategy.createElement(writer, listItem, { dataPipeline });
+        if (!markerElement) {
+            continue;
+        }
+        writer.setCustomProperty('listItemMarker', true, markerElement);
+        writer.insert(viewRange.start, markerElement);
+        viewRange = writer.createRange(writer.createPositionBefore(markerElement), writer.createPositionAfter(viewElement));
+        // Wrap the marker and optionally the first block with an attribute element (label for to-do lists).
+        if (!strategy.createWrapperElement || !strategy.canWrapElement) {
+            continue;
+        }
+        const wrapper = strategy.createWrapperElement(writer, listItem, { dataPipeline });
+        writer.setCustomProperty('listItemWrapper', true, wrapper);
+        // The whole block can be wrapped...
+        if (strategy.canWrapElement(listItem)) {
+            viewRange = writer.wrap(viewRange, wrapper);
+        }
+        else {
+            // ... or only the marker element (if the block is downcasted to heading or block widget).
+            viewRange = writer.wrap(writer.createRangeOn(markerElement), wrapper);
+            viewRange = writer.createRange(viewRange.start, writer.createPositionAfter(viewElement));
+        }
+    }
+    return viewRange;
+}
+/**
+ * Unwraps all ol, ul, and li attribute elements that are wrapping the provided view element.
+ */
 function unwrapListItemBlock(viewElement, viewWriter) {
     let attributeElement = viewElement.parent;
     while (attributeElement.is('attributeElement') && ['ul', 'ol', 'li'].includes(attributeElement.name)) {
@@ -290,7 +374,9 @@ function unwrapListItemBlock(viewElement, viewWriter) {
         attributeElement = parentElement;
     }
 }
-// Wraps the given list item with appropriate attribute elements for ul, ol, and li.
+/**
+ * Wraps the given list item with appropriate attribute elements for ul, ol, and li.
+ */
 function wrapListItemBlock(listItem, viewRange, strategies, writer) {
     if (!listItem.hasAttribute('listIndent')) {
         return;
@@ -301,7 +387,8 @@ function wrapListItemBlock(listItem, viewRange, strategies, writer) {
         const listItemViewElement = createListItemElement(writer, indent, currentListItem.getAttribute('listItemId'));
         const listViewElement = createListElement(writer, indent, currentListItem.getAttribute('listType'));
         for (const strategy of strategies) {
-            if (currentListItem.hasAttribute(strategy.attributeName)) {
+            if ((strategy.scope == 'list' || strategy.scope == 'item') &&
+                currentListItem.hasAttribute(strategy.attributeName)) {
                 strategy.setAttributeOnDowncast(writer, currentListItem.getAttribute(strategy.attributeName), strategy.scope == 'list' ? listViewElement : listItemViewElement);
             }
         }

package/src/documentlist/documentlistcommand.d.ts

@@ -14,7 +14,7 @@ export default class DocumentListCommand extends Command {
     /**
      * The type of the list created by the command.
      */
-    readonly type: 'numbered' | 'bulleted';
+    readonly type: 'numbered' | 'bulleted' | 'todo';
     /**
      * A flag indicating whether the command is active, which means that the selection starts in a list of the same type.
      *
@@ -28,7 +28,7 @@ export default class DocumentListCommand extends Command {
      * @param editor The editor instance.
      * @param type List type that will be handled by this command.
      */
-    constructor(editor: Editor, type: 'numbered' | 'bulleted');
+    constructor(editor: Editor, type: 'numbered' | 'bulleted' | 'todo');
     /**
      * @inheritDoc
      */

package/src/documentlist/documentlistcommand.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 import { Command } from 'ckeditor5/src/core';
-import { splitListItemBefore, expandListBlocksToCompleteItems, getListItemBlocks, getListItems, removeListAttributes, outdentFollowingItems, ListItemUid, sortBlocks, getSelectedBlockObject, isListItemBlock } from './utils/model';
+import { splitListItemBefore, expandListBlocksToCompleteItems, getListItemBlocks, getListItems, removeListAttributes, outdentFollowingItems, ListItemUid, sortBlocks, getSelectedBlockObject, isListItemBlock, canBecomeSimpleListItem } from './utils/model';
 /**
  * The list command. It is used by the {@link module:list/documentlist~DocumentList document list feature}.
  */
@@ -40,7 +40,7 @@ export default class DocumentListCommand extends Command {
         const document = model.document;
         const selectedBlockObject = getSelectedBlockObject(model);
         const blocks = Array.from(document.selection.getSelectedBlocks())
-            .filter(block => model.schema.checkAttribute(block, 'listType'));
+            .filter(block => model.schema.checkAttribute(block, 'listType') || canBecomeSimpleListItem(block, model.schema));
         // Whether we are turning off some items.
         const turnOff = options.forceValue !== undefined ? !options.forceValue : this.value;
         model.change(writer => {
@@ -52,13 +52,13 @@ export default class DocumentListCommand extends Command {
                 if (itemBlocks.length > 1) {
                     changedBlocks.push(...splitListItemBefore(itemBlocks[1], writer));
                 }
-                // Convert list blocks to plain blocks.
+                // Strip list attributes.
                 changedBlocks.push(...removeListAttributes(blocks, writer));
                 // Outdent items following the selected list item.
                 changedBlocks.push(...outdentFollowingItems(lastBlock, writer));
                 this._fireAfterExecute(changedBlocks);
             }
-            // Turning on the list items for a collapsed selection inside a list item.
+            // Changing type of list items for a collapsed selection inside a list item.
             else if ((selectedBlockObject || document.selection.isCollapsed) && isListItemBlock(blocks[0])) {
                 const changedBlocks = getListItems(selectedBlockObject || blocks[0]);
                 for (const block of changedBlocks) {
@@ -72,6 +72,10 @@ export default class DocumentListCommand extends Command {
                 for (const block of blocks) {
                     // Promote the given block to the list item.
                     if (!block.hasAttribute('listType')) {
+                        // Rename block to a simple list item if this option is enabled.
+                        if (!block.is('element', 'listItem') && canBecomeSimpleListItem(block, model.schema)) {
+                            writer.rename(block, 'listItem');
+                        }
                         writer.setAttributes({
                             listIndent: 0,
                             listItemId: ListItemUid.next(),
@@ -125,8 +129,9 @@ export default class DocumentListCommand extends Command {
      * @returns Whether the command should be enabled.
      */
     _checkEnabled() {
-        const selection = this.editor.model.document.selection;
-        const schema = this.editor.model.schema;
+        const model = this.editor.model;
+        const schema = model.schema;
+        const selection = model.document.selection;
         const blocks = Array.from(selection.getSelectedBlocks());
         if (!blocks.length) {
             return false;
@@ -136,7 +141,7 @@ export default class DocumentListCommand extends Command {
             return true;
         }
         for (const block of blocks) {
-            if (schema.checkAttribute(block, 'listType')) {
+            if (schema.checkAttribute(block, 'listType') || canBecomeSimpleListItem(block, schema)) {
                 return true;
             }
         }

package/src/documentlist/documentlistediting.d.ts

@@ -5,19 +5,20 @@
 /**
  * @module list/documentlist/documentlistediting
  */
-import { Plugin } from 'ckeditor5/src/core';
-import type { DowncastWriter, Element, ViewElement, Writer } from 'ckeditor5/src/engine';
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+import type { DowncastWriter, Element, ViewElement, ViewAttributeElement, Writer } from 'ckeditor5/src/engine';
 import { Delete } from 'ckeditor5/src/typing';
 import { Enter } from 'ckeditor5/src/enter';
 import DocumentListUtils from './documentlistutils';
 import { ListBlocksIterable } from './utils/listwalker';
+import { ClipboardPipeline } from 'ckeditor5/src/clipboard';
 import '../../theme/documentlist.css';
 import '../../theme/list.css';
 /**
  * Map of model attributes applicable to list blocks.
  */
 export interface ListItemAttributesMap {
-    listType?: 'numbered' | 'bulleted';
+    listType?: 'numbered' | 'bulleted' | 'todo';
     listIndent?: number;
     listItemId?: string;
 }
@@ -36,7 +37,11 @@ export default class DocumentListEditing extends Plugin {
     /**
      * @inheritDoc
      */
-    static get requires(): readonly [typeof Enter, typeof Delete, typeof DocumentListUtils];
+    static get requires(): readonly [typeof Enter, typeof Delete, typeof DocumentListUtils, typeof ClipboardPipeline];
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
     /**
      * @inheritDoc
      */
@@ -57,7 +62,7 @@ export default class DocumentListEditing extends Plugin {
     /**
      * Returns list of model attribute names that should affect downcast conversion.
      */
-    private _getListAttributeNames;
+    getListAttributeNames(): Array<string>;
     /**
      * Attaches the listener to the {@link module:engine/view/document~Document#event:delete} event and handles backspace/delete
      * keys in and around document lists.
@@ -88,9 +93,9 @@ export default class DocumentListEditing extends Plugin {
     private _setupClipboardIntegration;
 }
 /**
- * The downcast strategy.
+ * The attribute to attribute downcast strategy for UL, OL, LI elements.
  */
-export interface DowncastStrategy {
+export interface AttributeDowncastStrategy {
     /**
      * The scope of the downcast (whether it applies to LI or OL/UL).
      */
@@ -104,6 +109,40 @@ export interface DowncastStrategy {
      */
     setAttributeOnDowncast(writer: DowncastWriter, value: unknown, element: ViewElement): void;
 }
+/**
+ * The custom marker downcast strategy.
+ */
+export interface ItemMarkerDowncastStrategy {
+    /**
+     * The scope of the downcast.
+     */
+    scope: 'itemMarker';
+    /**
+     * The model attribute name.
+     */
+    attributeName: string;
+    /**
+     * Creates a view element for a custom item marker.
+     */
+    createElement(writer: DowncastWriter, modelElement: Element, { dataPipeline }: {
+        dataPipeline?: boolean;
+    }): ViewElement | null;
+    /**
+     * Creates an AttributeElement to be used for wrapping a first block of a list item.
+     */
+    createWrapperElement?(writer: DowncastWriter, modelElement: Element, { dataPipeline }: {
+        dataPipeline?: boolean;
+    }): ViewAttributeElement;
+    /**
+     * Should return true if the given list block can be wrapped with the wrapper created by `createWrapperElement()`
+     * or only the marker element should be wrapped.
+     */
+    canWrapElement?(modelElement: Element): boolean;
+}
+/**
+ * The downcast strategy.
+ */
+export type DowncastStrategy = AttributeDowncastStrategy | ItemMarkerDowncastStrategy;
 /**
  * Event fired on changes detected on the model list element to verify if the view representation of a list element
  * is representing those attributes.
@@ -152,3 +191,22 @@ export type DocumentListEditingCheckAttributesEvent = {
     ];
     return: boolean;
 };
+/**
+ * Event fired on changes detected on the model list element to verify if the view representation of a list block element
+ * is representing those attributes.
+ *
+ * It allows triggering a reconversion of a list item block.
+ *
+ * @internal
+ * @eventName ~DocumentListEditing#checkElement
+ */
+export type DocumentListEditingCheckElementEvent = {
+    name: 'checkElement';
+    args: [
+        {
+            viewElement: ViewElement;
+            modelElement: Element;
+        }
+    ];
+    return: boolean;
+};