@ckeditor/ckeditor5-list 41.3.0-alpha.4 → 41.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-list",
-  "version": "41.3.0-alpha.4",
+  "version": "41.3.1",
   "description": "Ordered and unordered lists feature to CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,7 +13,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "41.3.0-alpha.4"
+    "ckeditor5": "41.3.1"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",
@@ -25,7 +25,6 @@
     "directory": "packages/ckeditor5-list"
   },
   "files": [
-    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",

package/src/index.d.ts

@@ -6,11 +6,11 @@
  * @module list
  */
 export { default as List } from './list.js';
-export { default as ListEditing, type ListEditingPostFixerEvent } from './list/listediting.js';
+export { default as ListEditing, type ListEditingPostFixerEvent, type ListType } from './list/listediting.js';
 export { default as ListUtils } from './list/listutils.js';
 export { default as ListUI } from './list/listui.js';
 export { default as ListIndentCommand } from './list/listindentcommand.js';
-export type { default as ListCommand } from './list/listcommand.js';
+export { default as ListCommand } from './list/listcommand.js';
 export type { default as ListMergeCommand } from './list/listmergecommand.js';
 export type { default as ListSplitCommand } from './list/listsplitcommand.js';
 export { default as ListProperties } from './listproperties.js';

package/src/index.js

@@ -11,6 +11,7 @@ export { default as ListEditing } from './list/listediting.js';
 export { default as ListUtils } from './list/listutils.js';
 export { default as ListUI } from './list/listui.js';
 export { default as ListIndentCommand } from './list/listindentcommand.js';
+export { default as ListCommand } from './list/listcommand.js';
 // ListProperties.
 export { default as ListProperties } from './listproperties.js';
 export { default as ListPropertiesEditing } from './listproperties/listpropertiesediting.js';

package/src/legacylist/legacylistcommand.d.ts

@@ -3,6 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 import { Command, type Editor } from 'ckeditor5/src/core.js';
+import { type ListType } from '../list/listediting.js';
 /**
  * The list command. It is used by the {@link module:list/legacylist~LegacyList legacy list feature}.
  */
@@ -10,7 +11,7 @@ export default class LegacyListCommand extends Command {
     /**
      * The type of the list created by the command.
      */
-    readonly type: 'numbered' | 'bulleted' | 'todo';
+    readonly type: ListType;
     /**
      * A flag indicating whether the command is active, which means that the selection starts in a list of the same type.
      *
@@ -23,7 +24,7 @@ export default class LegacyListCommand extends Command {
      * @param editor The editor instance.
      * @param type List type that will be handled by this command.
      */
-    constructor(editor: Editor, type: 'numbered' | 'bulleted' | 'todo');
+    constructor(editor: Editor, type: ListType);
     /**
      * @inheritDoc
      */

package/src/legacylistproperties/legacyliststylecommand.js

@@ -86,6 +86,7 @@ export default class LegacyListStyleCommand extends Command {
             return;
         }
         const listType = getListTypeFromListStyleType(options.type);
+        /* istanbul ignore next -- @preserve */
         if (!listType) {
             return;
         }

package/src/list/converters.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module list/list/converters
  */
-import { type DowncastAttributeEvent, type EditingController, type Element, type ElementCreatorFunction, type Mapper, type Model, type UpcastElementEvent, type ViewElement } from 'ckeditor5/src/engine.js';
+import { type DowncastAttributeEvent, type EditingController, type Element, type ElementCreatorFunction, type Mapper, type Model, type UpcastElementEvent, type ViewElement, type DowncastRemoveEvent, type EditingView, type MapperModelToViewPositionEvent, type Schema } from 'ckeditor5/src/engine.js';
 import type { GetCallback } from 'ckeditor5/src/utils.js';
 import { type ListElement } from './utils/model.js';
 import type { default as ListEditing, DowncastStrategy } from './listediting.js';
@@ -44,6 +44,10 @@ export declare function reconvertItemsOnDataChange(model: Model, editing: Editin
 export declare function listItemDowncastConverter(attributeNames: Array<string>, strategies: Array<DowncastStrategy>, model: Model, { dataPipeline }?: {
     dataPipeline?: boolean;
 }): GetCallback<DowncastAttributeEvent<ListElement>>;
+/**
+ * The 'remove' downcast converter for custom markers.
+ */
+export declare function listItemDowncastRemoveConverter(schema: Schema): GetCallback<DowncastRemoveEvent>;
 /**
  * Returns the bogus paragraph view element creator. A bogus paragraph is used if a list item contains only a single block or nested list.
  *
@@ -63,3 +67,7 @@ export declare function bogusParagraphCreator(attributeNames: Array<string>, { d
  * @param model The model.
  */
 export declare function findMappedViewElement(element: Element, mapper: Mapper, model: Model): ViewElement | null;
+/**
+ * The model to view custom position mapping for cases when marker is injected at the beginning of a block.
+ */
+export declare function createModelToViewPositionMapper(strategies: Array<DowncastStrategy>, view: EditingView): GetCallback<MapperModelToViewPositionEvent>;

package/src/list/converters.js

@@ -265,6 +265,35 @@ export function listItemDowncastConverter(attributeNames, strategies, model, { d
         wrapListItemBlock(listItem, viewRange, strategies, writer);
     };
 }
+/**
+ * The 'remove' downcast converter for custom markers.
+ */
+export function listItemDowncastRemoveConverter(schema) {
+    return (evt, data, conversionApi) => {
+        const { writer, mapper } = conversionApi;
+        const elementName = evt.name.split(':')[1];
+        // Do not remove marker if the deleted element is some inline object inside paragraph.
+        // See https://github.com/cksource/ckeditor5-internal/issues/3680.
+        if (!schema.checkAttribute(elementName, 'listItemId')) {
+            return;
+        }
+        // Find the view range start position by mapping the model position at which the remove happened.
+        const viewStart = mapper.toViewPosition(data.position);
+        const modelEnd = data.position.getShiftedBy(data.length);
+        const viewEnd = mapper.toViewPosition(modelEnd, { isPhantom: true });
+        // Trim the range to remove in case some UI elements are on the view range boundaries.
+        const viewRange = writer.createRange(viewStart, viewEnd).getTrimmed();
+        // 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 = viewRange.end.nodeBefore;
+        /* istanbul ignore next -- @preserve */
+        if (!viewElement) {
+            return;
+        }
+        // Remove custom item marker.
+        removeCustomMarkerElements(viewElement, writer, mapper);
+    };
+}
 /**
  * Returns the bogus paragraph view element creator. A bogus paragraph is used if a list item contains only a single block or nested list.
  *
@@ -300,29 +329,69 @@ export function findMappedViewElement(element, mapper, model) {
     const viewRange = mapper.toViewRange(modelRange).getTrimmed();
     return viewRange.end.nodeBefore;
 }
+/**
+ * The model to view custom position mapping for cases when marker is injected at the beginning of a block.
+ */
+export function createModelToViewPositionMapper(strategies, view) {
+    return (evt, data) => {
+        if (data.modelPosition.offset > 0) {
+            return;
+        }
+        const positionParent = data.modelPosition.parent;
+        if (!isListItemBlock(positionParent)) {
+            return;
+        }
+        if (!strategies.some(strategy => (strategy.scope == 'itemMarker' &&
+            strategy.canInjectMarkerIntoElement &&
+            strategy.canInjectMarkerIntoElement(positionParent)))) {
+            return;
+        }
+        const viewElement = data.mapper.toViewElement(positionParent);
+        const viewRange = view.createRangeIn(viewElement);
+        const viewWalker = viewRange.getWalker();
+        let positionAfterLastMarker = viewRange.start;
+        for (const { item } of viewWalker) {
+            // Walk only over the non-mapped elements (UIElements, AttributeElements, $text, or any other element without mapping).
+            if (item.is('element') && data.mapper.toModelElement(item) || item.is('$textProxy')) {
+                break;
+            }
+            if (item.is('element') && item.getCustomProperty('listItemMarker')) {
+                positionAfterLastMarker = view.createPositionAfter(item);
+                // Jump over the content of the marker (this is not needed for UIElement but required for other element types).
+                viewWalker.skip(({ previousPosition }) => !previousPosition.isEqual(positionAfterLastMarker));
+            }
+        }
+        data.viewPosition = positionAfterLastMarker;
+    };
+}
 /**
  * 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);
+        viewWriter.unwrap(viewWriter.createRangeOn(viewElement), 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);
-        }
-    }
+    // Markers before a block.
+    collectMarkersToRemove(viewWriter.createPositionBefore(viewElement).getWalker({ direction: 'backward' }));
+    // Markers inside a block.
+    collectMarkersToRemove(viewWriter.createRangeIn(viewElement).getWalker());
     for (const marker of markersToRemove) {
         viewWriter.remove(marker);
     }
+    function collectMarkersToRemove(viewWalker) {
+        for (const { item } of viewWalker) {
+            // Walk only over the non-mapped elements (UIElements, AttributeElements, $text, or any other element without mapping).
+            if (item.is('element') && mapper.toModelElement(item)) {
+                break;
+            }
+            if (item.is('element') && item.getCustomProperty('listItemMarker')) {
+                markersToRemove.push(item);
+            }
+        }
+    }
 }
 /**
  * Inserts a custom marker elements and wraps first block of a list item if marker requires it.
@@ -343,8 +412,13 @@ function insertCustomMarkerElements(listItem, viewElement, strategies, writer, {
             continue;
         }
         writer.setCustomProperty('listItemMarker', true, markerElement);
-        writer.insert(viewRange.start, markerElement);
-        viewRange = writer.createRange(writer.createPositionBefore(markerElement), writer.createPositionAfter(viewElement));
+        if (strategy.canInjectMarkerIntoElement && strategy.canInjectMarkerIntoElement(listItem)) {
+            writer.insert(writer.createPositionAt(viewElement, 0), markerElement);
+        }
+        else {
+            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;

package/src/list/listcommand.d.ts

@@ -7,6 +7,7 @@
  */
 import type { Element } from 'ckeditor5/src/engine.js';
 import { Command, type Editor } from 'ckeditor5/src/core.js';
+import { type ListType } from './listediting.js';
 /**
  * The list command. It is used by the {@link module:list/list~List list feature}.
  */
@@ -14,7 +15,7 @@ export default class ListCommand extends Command {
     /**
      * The type of the list created by the command.
      */
-    readonly type: 'numbered' | 'bulleted' | 'todo';
+    readonly type: ListType;
     /**
      * A flag indicating whether the command is active, which means that the selection starts in a list of the same type.
      *
@@ -22,13 +23,22 @@ export default class ListCommand extends Command {
      * @readonly
      */
     value: boolean;
+    /**
+     * List Walker options that change the range of the list items to be changed when the selection is collapsed within a list item.
+     *
+     * In a multi-level list, when the selection is collapsed within a list item, instead of changing only the list items of the same list
+     * type and current indent level, the entire list structure is changed (all list items at all indent levels of any list type).
+     */
+    private readonly _listWalkerOptions?;
     /**
      * Creates an instance of the command.
      *
      * @param editor The editor instance.
      * @param type List type that will be handled by this command.
      */
-    constructor(editor: Editor, type: 'numbered' | 'bulleted' | 'todo');
+    constructor(editor: Editor, type: ListType, options?: {
+        multiLevel?: boolean;
+    });
     /**
      * @inheritDoc
      */
@@ -42,9 +52,11 @@ export default class ListCommand extends Command {
      * @param options.forceValue If set, it will force the command behavior. If `true`, the command will try to convert the
      * selected items and potentially the neighbor elements to the proper list items. If set to `false` it will convert selected elements
      * to paragraphs. If not set, the command will toggle selected elements to list items or paragraphs, depending on the selection.
+     * @param options.additionalAttributes Additional attributes that are set for list items when the command is executed.
      */
     execute(options?: {
         forceValue?: boolean;
+        additionalAttributes?: Record<string, unknown>;
     }): void;
     /**
      * Fires the `afterExecute` event.

package/src/list/listcommand.js

@@ -14,9 +14,14 @@ export default class ListCommand extends Command {
      * @param editor The editor instance.
      * @param type List type that will be handled by this command.
      */
-    constructor(editor, type) {
+    constructor(editor, type, options = {}) {
         super(editor);
         this.type = type;
+        this._listWalkerOptions = options.multiLevel ? {
+            higherIndent: true,
+            lowerIndent: true,
+            sameAttributes: []
+        } : undefined;
     }
     /**
      * @inheritDoc
@@ -34,6 +39,7 @@ export default class ListCommand extends Command {
      * @param options.forceValue If set, it will force the command behavior. If `true`, the command will try to convert the
      * selected items and potentially the neighbor elements to the proper list items. If set to `false` it will convert selected elements
      * to paragraphs. If not set, the command will toggle selected elements to list items or paragraphs, depending on the selection.
+     * @param options.additionalAttributes Additional attributes that are set for list items when the command is executed.
      */
     execute(options = {}) {
         const model = this.editor.model;
@@ -60,9 +66,12 @@ export default class ListCommand extends Command {
             }
             // 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]);
+                const changedBlocks = getListItems(selectedBlockObject || blocks[0], this._listWalkerOptions);
                 for (const block of changedBlocks) {
-                    writer.setAttribute('listType', this.type, block);
+                    writer.setAttributes({
+                        ...options.additionalAttributes,
+                        listType: this.type
+                    }, block);
                 }
                 this._fireAfterExecute(changedBlocks);
             }
@@ -77,6 +86,7 @@ export default class ListCommand extends Command {
                             writer.rename(block, 'listItem');
                         }
                         writer.setAttributes({
+                            ...options.additionalAttributes,
                             listIndent: 0,
                             listItemId: ListItemUid.next(),
                             listType: this.type
@@ -87,7 +97,10 @@ export default class ListCommand extends Command {
                     else {
                         for (const node of expandListBlocksToCompleteItems(block, { withNested: false })) {
                             if (node.getAttribute('listType') != this.type) {
-                                writer.setAttribute('listType', this.type, node);
+                                writer.setAttributes({
+                                    ...options.additionalAttributes,
+                                    listType: this.type
+                                }, node);
                                 changedBlocks.push(node);
                             }
                         }

package/src/list/listediting.d.ts

@@ -14,11 +14,12 @@ import { ListBlocksIterable } from './utils/listwalker.js';
 import { ClipboardPipeline } from 'ckeditor5/src/clipboard.js';
 import '../../theme/documentlist.css';
 import '../../theme/list.css';
+export type ListType = 'numbered' | 'bulleted' | 'todo' | 'customNumbered' | 'customBulleted';
 /**
  * Map of model attributes applicable to list blocks.
  */
 export interface ListItemAttributesMap {
-    listType?: 'numbered' | 'bulleted' | 'todo';
+    listType?: ListType;
     listIndent?: number;
     listItemId?: string;
 }
@@ -142,6 +143,11 @@ export interface ItemMarkerDowncastStrategy {
      * or only the marker element should be wrapped.
      */
     canWrapElement?(modelElement: Element): boolean;
+    /**
+     * Should return true if the custom marker can be injected into a given list block.
+     * Otherwise, custom marker view element is always injected before the block element.
+     */
+    canInjectMarkerIntoElement?(modelElement: Element): boolean;
 }
 /**
  * The downcast strategy.

package/src/list/listediting.js

@@ -14,7 +14,7 @@ import ListCommand from './listcommand.js';
 import ListMergeCommand from './listmergecommand.js';
 import ListSplitCommand from './listsplitcommand.js';
 import ListUtils from './listutils.js';
-import { bogusParagraphCreator, listItemDowncastConverter, listItemUpcastConverter, listUpcastCleanList, reconvertItemsOnDataChange } from './converters.js';
+import { bogusParagraphCreator, createModelToViewPositionMapper, listItemDowncastConverter, listItemDowncastRemoveConverter, listItemUpcastConverter, listUpcastCleanList, reconvertItemsOnDataChange } from './converters.js';
 import { findAndAddListHeadToMap, fixListIndents, fixListItemIds } from './utils/postfixers.js';
 import { getAllListItemBlocks, isFirstBlockOfListItem, isLastBlockOfListItem, isSingleListItem, getSelectedBlockObject, isListItemBlock, removeListAttributes, ListItemUid } from './utils/model.js';
 import { getViewElementIdForListType, getViewElementNameForListType } from './utils/view.js';
@@ -89,6 +89,8 @@ export default class ListEditing extends Plugin {
         // Register commands.
         editor.commands.add('numberedList', new ListCommand(editor, 'numbered'));
         editor.commands.add('bulletedList', new ListCommand(editor, 'bulleted'));
+        editor.commands.add('customNumberedList', new ListCommand(editor, 'customNumbered', { multiLevel: true }));
+        editor.commands.add('customBulletedList', new ListCommand(editor, 'customBulleted', { multiLevel: true }));
         editor.commands.add('indentList', new ListIndentCommand(editor, 'forward'));
         editor.commands.add('outdentList', new ListIndentCommand(editor, 'backward'));
         editor.commands.add('splitListItemBefore', new ListSplitCommand(editor, 'before'));
@@ -347,6 +349,7 @@ export default class ListEditing extends Plugin {
         })
             .add(dispatcher => {
             dispatcher.on('attribute', listItemDowncastConverter(attributeNames, this._downcastStrategies, model));
+            dispatcher.on('remove', listItemDowncastRemoveConverter(model.schema));
         });
         editor.conversion.for('dataDowncast')
             .elementToElement({
@@ -357,6 +360,9 @@ export default class ListEditing extends Plugin {
             .add(dispatcher => {
             dispatcher.on('attribute', listItemDowncastConverter(attributeNames, this._downcastStrategies, model, { dataPipeline: true }));
         });
+        const modelToViewPositionMapper = createModelToViewPositionMapper(this._downcastStrategies, editor.editing.view);
+        editor.editing.mapper.on('modelToViewPosition', modelToViewPositionMapper);
+        editor.data.mapper.on('modelToViewPosition', modelToViewPositionMapper);
         this.listenTo(model.document, 'change:data', reconvertItemsOnDataChange(model, editor.editing, attributeNames, this), { priority: 'high' });
         // For LI verify if an ID of the attribute element is correct.
         this.on('checkAttributes:item', (evt, { viewElement, modelAttributes }) => {

package/src/list/listui.js

@@ -5,7 +5,7 @@
 /**
  * @module list/list/listui
  */
-import { createUIComponent } from './utils.js';
+import { createUIComponents } from './utils.js';
 import { icons, Plugin } from 'ckeditor5/src/core.js';
 /**
  * The list UI feature. It introduces the `'numberedList'` and `'bulletedList'` buttons that
@@ -24,7 +24,7 @@ export default class ListUI extends Plugin {
     init() {
         const t = this.editor.t;
         // Create two buttons and link them with numberedList and bulletedList commands.
-        createUIComponent(this.editor, 'numberedList', t('Numbered List'), icons.numberedList);
-        createUIComponent(this.editor, 'bulletedList', t('Bulleted List'), icons.bulletedList);
+        createUIComponents(this.editor, 'numberedList', t('Numbered List'), icons.numberedList);
+        createUIComponents(this.editor, 'bulletedList', t('Bulleted List'), icons.bulletedList);
     }
 }

package/src/list/listutils.d.ts

@@ -8,6 +8,8 @@
 import type { Element, Node } from 'ckeditor5/src/engine.js';
 import type { ArrayOrItem } from 'ckeditor5/src/utils.js';
 import { Plugin } from 'ckeditor5/src/core.js';
+import { type ListElement } from './utils/model.js';
+import type { ListType } from './listediting.js';
 /**
  * A set of helpers related to document lists.
  */
@@ -33,7 +35,7 @@ export default class ListUtils extends Plugin {
      *
      * @param node A model node.
      */
-    isListItemBlock(node: Node): boolean;
+    isListItemBlock(node: Node | null): node is ListElement;
     /**
      * Expands the given list of selected blocks to include the leading and tailing blocks of partially selected list items.
      *
@@ -43,4 +45,8 @@ export default class ListUtils extends Plugin {
     expandListBlocksToCompleteItems(blocks: ArrayOrItem<Element>, options?: {
         withNested?: boolean;
     }): Array<Element>;
+    /**
+     * Returns true if listType is of type `numbered` or `customNumbered`.
+     */
+    isNumberedListType(listType: ListType): boolean;
 }

package/src/list/listutils.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import { expandListBlocksToCompleteItems, expandListBlocksToCompleteList, isFirstBlockOfListItem, isListItemBlock } from './utils/model.js';
+import { expandListBlocksToCompleteItems, expandListBlocksToCompleteList, isFirstBlockOfListItem, isListItemBlock, isNumberedListType } from './utils/model.js';
 /**
  * A set of helpers related to document lists.
  */
@@ -47,4 +47,10 @@ export default class ListUtils extends Plugin {
     expandListBlocksToCompleteItems(blocks, options = {}) {
         return expandListBlocksToCompleteItems(blocks, options);
     }
+    /**
+     * Returns true if listType is of type `numbered` or `customNumbered`.
+     */
+    isNumberedListType(listType) {
+        return isNumberedListType(listType);
+    }
 }

package/src/list/utils/listwalker.d.ts

@@ -58,14 +58,7 @@ export default class ListWalker {
      * @param options.higherIndent Whether blocks with a higher indent level than the start block should be included
      * in the result.
      */
-    constructor(startElement: Node, options: {
-        direction?: 'forward' | 'backward';
-        includeSelf?: boolean;
-        sameAttributes?: ArrayOrItem<string>;
-        sameIndent?: boolean;
-        lowerIndent?: boolean;
-        higherIndent?: boolean;
-    });
+    constructor(startElement: Node, options: ListWalkerOptions);
     /**
      * Performs only first step of iteration and returns the result.
      *
@@ -80,14 +73,7 @@ export default class ListWalker {
      * @param options.higherIndent Whether blocks with a higher indent level than the start block should be included
      * in the result.
      */
-    static first(startElement: Node, options: {
-        direction?: 'forward' | 'backward';
-        includeSelf?: boolean;
-        sameAttributes?: ArrayOrItem<string>;
-        sameIndent?: boolean;
-        lowerIndent?: boolean;
-        higherIndent?: boolean;
-    }): ListElement | null;
+    static first(startElement: Node, options: ListWalkerOptions): ListElement | null;
     /**
      * Iterable interface.
      */
@@ -143,3 +129,14 @@ export interface ListIteratorValue {
      */
     previousNodeInList: ListElement | null;
 }
+/**
+ * Document list blocks iterator options.
+ */
+export type ListWalkerOptions = {
+    direction?: 'forward' | 'backward';
+    includeSelf?: boolean;
+    sameAttributes?: ArrayOrItem<string>;
+    sameIndent?: boolean;
+    lowerIndent?: boolean;
+    higherIndent?: boolean;
+};

package/src/list/utils/model.d.ts

@@ -7,6 +7,8 @@
  */
 import type { DocumentFragment, Element, Model, Node, Writer, Item, Schema } from 'ckeditor5/src/engine.js';
 import { type ArrayOrItem } from 'ckeditor5/src/utils.js';
+import { type ListWalkerOptions } from './listwalker.js';
+import { type ListType } from '../listediting.js';
 /**
  * The list item ID generator.
  *
@@ -28,7 +30,7 @@ export declare class ListItemUid {
 export interface ListElement extends Element {
     getAttribute(key: 'listItemId'): string;
     getAttribute(key: 'listIndent'): number;
-    getAttribute(key: 'listType'): 'numbered' | 'bulleted' | 'todo';
+    getAttribute(key: 'listType'): ListType;
     getAttribute(key: string): unknown;
 }
 /**
@@ -77,8 +79,9 @@ export declare function getNestedListBlocks(listItem: Element): Array<ListElemen
  *
  * @internal
  * @param listItem Starting list item element.
+ * @param options Additional list walker options to modify the range of returned list items.
  */
-export declare function getListItems(listItem: Element): Array<ListElement>;
+export declare function getListItems(listItem: Element, options?: ListWalkerOptions): Array<ListElement>;
 /**
  * Check if the given block is the first in the list item.
  *
@@ -200,3 +203,7 @@ export declare function getSelectedBlockObject(model: Model): Element | null;
  * @param schema The schema of the document.
  */
 export declare function canBecomeSimpleListItem(block: Element, schema: Schema): boolean;
+/**
+ * Returns true if listType is of type `numbered` or `customNumbered`.
+ */
+export declare function isNumberedListType(listType: ListType): boolean;

package/src/list/utils/model.js

@@ -82,17 +82,20 @@ export function getNestedListBlocks(listItem) {
  *
  * @internal
  * @param listItem Starting list item element.
+ * @param options Additional list walker options to modify the range of returned list items.
  */
-export function getListItems(listItem) {
+export function getListItems(listItem, options) {
     const backwardBlocks = new ListWalker(listItem, {
         sameIndent: true,
-        sameAttributes: 'listType'
+        sameAttributes: 'listType',
+        ...options
     });
     const forwardBlocks = new ListWalker(listItem, {
         sameIndent: true,
         sameAttributes: 'listType',
         includeSelf: true,
-        direction: 'forward'
+        direction: 'forward',
+        ...options
     });
     return [
         ...Array.from(backwardBlocks).reverse(),
@@ -434,6 +437,12 @@ export function getSelectedBlockObject(model) {
 export function canBecomeSimpleListItem(block, schema) {
     return schema.checkChild(block.parent, 'listItem') && schema.checkChild(block, '$text') && !schema.isObject(block);
 }
+/**
+ * Returns true if listType is of type `numbered` or `customNumbered`.
+ */
+export function isNumberedListType(listType) {
+    return listType == 'numbered' || listType == 'customNumbered';
+}
 /**
  * Merges a given block to the given parent block if parent is a list item and there is no more blocks in the same item.
  */

package/src/list/utils/view.d.ts

@@ -6,6 +6,7 @@
  * @module list/list/utils/view
  */
 import type { DowncastWriter, ViewAttributeElement, ViewDocumentFragment, ViewElement, ViewNode } from 'ckeditor5/src/engine.js';
+import { type ListType } from '../listediting.js';
 /**
  * Checks if view element is a list type (ul or ol).
  *
@@ -60,7 +61,7 @@ export declare function getIndent(listItem: ViewElement): number;
  *
  * @internal
  */
-export declare function createListElement(writer: DowncastWriter, indent: number, type: 'bulleted' | 'numbered' | 'todo', id?: string): ViewAttributeElement;
+export declare function createListElement(writer: DowncastWriter, indent: number, type: ListType, id?: string): ViewAttributeElement;
 /**
  * Creates a list item attribute element (li).
  *
@@ -72,10 +73,10 @@ export declare function createListItemElement(writer: DowncastWriter, indent: nu
  *
  * @internal
  */
-export declare function getViewElementNameForListType(type?: 'bulleted' | 'numbered' | 'todo'): 'ol' | 'ul';
+export declare function getViewElementNameForListType(type?: ListType): 'ol' | 'ul';
 /**
  * Returns a view element ID for the given list type and indent.
  *
  * @internal
  */
-export declare function getViewElementIdForListType(type?: 'bulleted' | 'numbered' | 'todo', indent?: number): string;
+export declare function getViewElementIdForListType(type?: ListType, indent?: number): string;

package/src/list/utils/view.js

@@ -105,7 +105,7 @@ export function createListItemElement(writer, indent, id) {
  * @internal
  */
 export function getViewElementNameForListType(type) {
-    return type == 'numbered' ? 'ol' : 'ul';
+    return type == 'numbered' || type == 'customNumbered' ? 'ol' : 'ul';
 }
 /**
  * Returns a view element ID for the given list type and indent.