@ckeditor/ckeditor5-list 41.1.0 → 41.3.0-alpha.0

package/dist/types/augmentation.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { List, ListEditing, ListUtils, ListUI, ListCommand, ListIndentCommand, ListMergeCommand, ListSplitCommand, ListProperties, ListPropertiesUtils, ListPropertiesEditing, ListPropertiesUI, ListStyleCommand, ListStartCommand, ListReversedCommand, TodoList, TodoListEditing, TodoListUI, CheckTodoListCommand, LegacyList, LegacyListEditing, LegacyListUtils, LegacyListCommand, LegacyIndentCommand, LegacyListProperties, LegacyListPropertiesEditing, LegacyListStyleCommand, LegacyListStartCommand, LegacyListReversedCommand, LegacyTodoList, LegacyTodoListEditing, LegacyCheckTodoListCommand, ListConfig, DocumentList, DocumentListProperties, TodoDocumentList } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:list/list~List} feature and the {@link module:list/legacylist~LegacyList} feature.
+         *
+         * Read more in {@link module:list/listconfig~ListConfig}.
+         */
+        list?: ListConfig;
+    }
+    interface PluginsMap {
+        [List.pluginName]: List;
+        [ListEditing.pluginName]: ListEditing;
+        [ListUtils.pluginName]: ListUtils;
+        [ListUI.pluginName]: ListUI;
+        [ListProperties.pluginName]: ListProperties;
+        [ListPropertiesEditing.pluginName]: ListPropertiesEditing;
+        [ListPropertiesUtils.pluginName]: ListPropertiesUtils;
+        [ListPropertiesUI.pluginName]: ListPropertiesUI;
+        [TodoList.pluginName]: TodoDocumentList;
+        [TodoListEditing.pluginName]: TodoListEditing;
+        [TodoListUI.pluginName]: TodoListUI;
+        [LegacyList.pluginName]: LegacyList;
+        [LegacyListEditing.pluginName]: LegacyListEditing;
+        [LegacyListUtils.pluginName]: LegacyListUtils;
+        [LegacyListProperties.pluginName]: LegacyListProperties;
+        [LegacyListPropertiesEditing.pluginName]: LegacyListPropertiesEditing;
+        [LegacyTodoList.pluginName]: LegacyTodoList;
+        [LegacyTodoListEditing.pluginName]: LegacyTodoListEditing;
+        [DocumentList.pluginName]: DocumentList;
+        [DocumentListProperties.pluginName]: DocumentListProperties;
+        [TodoDocumentList.pluginName]: TodoDocumentList;
+    }
+    interface CommandsMap {
+        numberedList: LegacyListCommand | ListCommand;
+        bulletedList: LegacyListCommand | ListCommand;
+        indentList: LegacyIndentCommand | ListIndentCommand;
+        outdentList: LegacyIndentCommand | ListIndentCommand;
+        mergeListItemBackward: ListMergeCommand;
+        mergeListItemForward: ListMergeCommand;
+        splitListItemBefore: ListSplitCommand;
+        splitListItemAfter: ListSplitCommand;
+        listStyle: LegacyListStyleCommand | ListStyleCommand;
+        listStart: LegacyListStartCommand | ListStartCommand;
+        listReversed: LegacyListReversedCommand | ListReversedCommand;
+        todoList: LegacyListCommand | ListCommand;
+        checkTodoList: LegacyCheckTodoListCommand | CheckTodoListCommand;
+    }
+}

package/dist/types/documentlist.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/documentlist
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import List from './list.js';
+/**
+ * The document list feature.
+ *
+ * This is an obsolete plugin that exists for backward compatibility only.
+ * Use the {@link module:list/list~List `List`} instead.
+ *
+ * @deprecated
+ */
+export default class DocumentList extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof List];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "DocumentList";
+    constructor(editor: Editor);
+}

package/dist/types/documentlistproperties.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/documentlistproperties
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import ListProperties from './listproperties.js';
+/**
+ * The document list properties feature.
+ *
+ * This is an obsolete plugin that exists for backward compatibility only.
+ * Use the {@link module:list/listproperties~ListProperties `ListProperties`} instead.
+ *
+ * @deprecated
+ */
+export default class DocumentListProperties extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ListProperties];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "DocumentListProperties";
+    constructor(editor: Editor);
+}

package/dist/types/index.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list
+ */
+export { default as List } from './list.js';
+export { default as ListEditing, type ListEditingPostFixerEvent } 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 type { default as ListMergeCommand } from './list/listmergecommand.js';
+export type { default as ListSplitCommand } from './list/listsplitcommand.js';
+export { default as ListProperties } from './listproperties.js';
+export { default as ListPropertiesEditing } from './listproperties/listpropertiesediting.js';
+export { default as ListPropertiesUtils } from './listproperties/listpropertiesutils.js';
+export { default as ListPropertiesUI } from './listproperties/listpropertiesui.js';
+export type { default as ListReversedCommand } from './listproperties/listreversedcommand.js';
+export type { default as ListStartCommand } from './listproperties/liststartcommand.js';
+export type { default as ListStyleCommand } from './listproperties/liststylecommand.js';
+export { default as TodoList } from './todolist.js';
+export { default as TodoListUI } from './todolist/todolistui.js';
+export { default as TodoListEditing } from './todolist/todolistediting.js';
+export type { default as CheckTodoListCommand } from './todolist/checktodolistcommand.js';
+export { default as LegacyList } from './legacylist.js';
+export { default as LegacyListEditing } from './legacylist/legacylistediting.js';
+export { default as LegacyListUtils } from './legacylist/legacylistutils.js';
+export { default as LegacyIndentCommand } from './legacylist/legacyindentcommand.js';
+export type { default as LegacyListCommand } from './legacylist/legacylistcommand.js';
+export { default as LegacyListProperties } from './legacylistproperties.js';
+export { default as LegacyListPropertiesEditing } from './legacylistproperties/legacylistpropertiesediting.js';
+export type { default as LegacyListReversedCommand } from './legacylistproperties/legacylistreversedcommand.js';
+export type { default as LegacyListStartCommand } from './legacylistproperties/legacyliststartcommand.js';
+export type { default as LegacyListStyleCommand } from './legacylistproperties/legacyliststylecommand.js';
+export { default as LegacyTodoList } from './legacytodolist.js';
+export { default as LegacyTodoListEditing } from './legacytodolist/legacytodolistediting.js';
+export type { default as LegacyCheckTodoListCommand } from './legacytodolist/legacychecktodolistcommand.js';
+export type { ListConfig, ListPropertiesConfig } from './listconfig.js';
+export { default as AdjacentListsSupport } from './list/adjacentlistssupport.js';
+export { default as DocumentList } from './documentlist.js';
+export { default as DocumentListProperties } from './documentlistproperties.js';
+export { default as TodoDocumentList } from './tododocumentlist.js';
+import './augmentation.js';

package/dist/types/legacylist/legacyconverters.d.ts

@@ -0,0 +1,196 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/legacylist/legacyconverters
+ */
+import { type DowncastAttributeEvent, type DowncastInsertEvent, type DowncastRemoveEvent, type Element, type MapperModelToViewPositionEvent, type MapperViewToModelPositionEvent, type Model, type ModelInsertContentEvent, type UpcastElementEvent, type EditingView, type Writer } from 'ckeditor5/src/engine.js';
+import type { GetCallback } from 'ckeditor5/src/utils.js';
+/**
+ * A model-to-view converter for the `listItem` model element insertion.
+ *
+ * It creates a `<ul><li></li><ul>` (or `<ol>`) view structure out of a `listItem` model element, inserts it at the correct
+ * position, and merges the list with surrounding lists (if available).
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
+ * @param model Model instance.
+ */
+export declare function modelViewInsertion(model: Model): GetCallback<DowncastInsertEvent<Element>>;
+/**
+ * A model-to-view converter for the `listItem` model element removal.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:remove
+ * @param model Model instance.
+ * @returns Returns a conversion callback.
+ */
+export declare function modelViewRemove(model: Model): GetCallback<DowncastRemoveEvent>;
+/**
+ * A model-to-view converter for the `type` attribute change on the `listItem` model element.
+ *
+ * This change means that the `<li>` element parent changes from `<ul>` to `<ol>` (or vice versa). This is accomplished
+ * by breaking view elements and changing their name. The next {@link module:list/legacylist/legacyconverters~modelViewMergeAfterChangeType}
+ * converter will attempt to merge split nodes.
+ *
+ * Splitting this conversion into 2 steps makes it possible to add an additional conversion in the middle.
+ * Check {@link module:list/legacytodolist/legacytodolistconverters~modelViewChangeType} to see an example of it.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
+ */
+export declare const modelViewChangeType: GetCallback<DowncastAttributeEvent<Element>>;
+/**
+ * A model-to-view converter that attempts to merge nodes split by {@link module:list/legacylist/legacyconverters~modelViewChangeType}.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
+ */
+export declare const modelViewMergeAfterChangeType: GetCallback<DowncastAttributeEvent<Element>>;
+/**
+ * A model-to-view converter for the `listIndent` attribute change on the `listItem` model element.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
+ * @param model Model instance.
+ * @returns Returns a conversion callback.
+ */
+export declare function modelViewChangeIndent(model: Model): GetCallback<DowncastAttributeEvent<Element>>;
+/**
+ * A special model-to-view converter introduced by the {@link module:list/legacylist~LegacyList list feature}. This converter is fired for
+ * insert change of every model item, and should be fired before the actual converter. The converter checks whether the inserted
+ * model item is a non-`listItem` element. If it is, and it is inserted inside a view list, the converter breaks the
+ * list so the model element is inserted to the view parent element corresponding to its model parent element.
+ *
+ * The converter prevents such situations:
+ *
+ * ```xml
+ * // Model:                        // View:
+ * <listItem>foo</listItem>         <ul>
+ * <listItem>bar</listItem>             <li>foo</li>
+ *                                      <li>bar</li>
+ *                                  </ul>
+ *
+ * // After change:                 // Correct view guaranteed by this converter:
+ * <listItem>foo</listItem>         <ul><li>foo</li></ul><p>xxx</p><ul><li>bar</li></ul>
+ * <paragraph>xxx</paragraph>       // Instead of this wrong view state:
+ * <listItem>bar</listItem>         <ul><li>foo</li><p>xxx</p><li>bar</li></ul>
+ * ```
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
+ */
+export declare const modelViewSplitOnInsert: GetCallback<DowncastInsertEvent<Element>>;
+/**
+ * A special model-to-view converter introduced by the {@link module:list/legacylist~LegacyList list feature}. This converter takes care of
+ * merging view lists after something is removed or moved from near them.
+ *
+ * Example:
+ *
+ * ```xml
+ * // Model:                        // View:
+ * <listItem>foo</listItem>         <ul><li>foo</li></ul>
+ * <paragraph>xxx</paragraph>       <p>xxx</p>
+ * <listItem>bar</listItem>         <ul><li>bar</li></ul>
+ *
+ * // After change:                 // Correct view guaranteed by this converter:
+ * <listItem>foo</listItem>         <ul>
+ * <listItem>bar</listItem>             <li>foo</li>
+ *                                      <li>bar</li>
+ *                                  </ul>
+ * ```
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:remove
+ */
+export declare const modelViewMergeAfter: GetCallback<DowncastRemoveEvent>;
+/**
+ * A view-to-model converter that converts the `<li>` view elements into the `listItem` model elements.
+ *
+ * To set correct values of the `listType` and `listIndent` attributes the converter:
+ * * checks `<li>`'s parent,
+ * * stores and increases the `conversionApi.store.indent` value when `<li>`'s sub-items are converted.
+ *
+ * @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
+ */
+export declare const viewModelConverter: GetCallback<UpcastElementEvent>;
+/**
+ * A view-to-model converter for the `<ul>` and `<ol>` view elements that cleans the input view of garbage.
+ * This is mostly to clean whitespaces from between the `<li>` view elements inside the view list element, however, also
+ * incorrect data can be cleared if the view was incorrect.
+ *
+ * @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
+ */
+export declare const cleanList: GetCallback<UpcastElementEvent>;
+/**
+ * A view-to-model converter for the `<li>` elements that cleans whitespace formatting from the input view.
+ *
+ * @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
+ */
+export declare const cleanListItem: GetCallback<UpcastElementEvent>;
+/**
+ * Returns a callback for model position to view position mapping for {@link module:engine/conversion/mapper~Mapper}. The callback fixes
+ * positions between the `listItem` elements that would be incorrectly mapped because of how list items are represented in the model
+ * and in the view.
+ */
+export declare function modelToViewPosition(view: EditingView): GetCallback<MapperModelToViewPositionEvent>;
+/**
+ * The callback for view position to model position mapping for {@link module:engine/conversion/mapper~Mapper}. The callback fixes
+ * positions between the `<li>` elements that would be incorrectly mapped because of how list items are represented in the model
+ * and in the view.
+ *
+ * @see module:engine/conversion/mapper~Mapper#event:viewToModelPosition
+ * @param model Model instance.
+ * @returns Returns a conversion callback.
+ */
+export declare function viewToModelPosition(model: Model): GetCallback<MapperViewToModelPositionEvent>;
+/**
+ * Post-fixer that reacts to changes on document and fixes incorrect model states.
+ *
+ * In the example below, there is a correct list structure.
+ * Then the middle element is removed so the list structure will become incorrect:
+ *
+ * ```xml
+ * <listItem listType="bulleted" listIndent=0>Item 1</listItem>
+ * <listItem listType="bulleted" listIndent=1>Item 2</listItem>   <--- this is removed.
+ * <listItem listType="bulleted" listIndent=2>Item 3</listItem>
+ * ```
+ *
+ * The list structure after the middle element is removed:
+ *
+ * ```xml
+ * <listItem listType="bulleted" listIndent=0>Item 1</listItem>
+ * <listItem listType="bulleted" listIndent=2>Item 3</listItem>
+ * ```
+ *
+ * Should become:
+ *
+ * ```xml
+ * <listItem listType="bulleted" listIndent=0>Item 1</listItem>
+ * <listItem listType="bulleted" listIndent=1>Item 3</listItem>   <--- note that indent got post-fixed.
+ * ```
+ *
+ * @param model The data model.
+ * @param writer The writer to do changes with.
+ * @returns `true` if any change has been applied, `false` otherwise.
+ */
+export declare function modelChangePostFixer(model: Model, writer: Writer): boolean;
+/**
+ * A fixer for pasted content that includes list items.
+ *
+ * It fixes indentation of pasted list items so the pasted items match correctly to the context they are pasted into.
+ *
+ * Example:
+ *
+ * ```xml
+ * <listItem listType="bulleted" listIndent=0>A</listItem>
+ * <listItem listType="bulleted" listIndent=1>B^</listItem>
+ * // At ^ paste:  <listItem listType="bulleted" listIndent=4>X</listItem>
+ * //              <listItem listType="bulleted" listIndent=5>Y</listItem>
+ * <listItem listType="bulleted" listIndent=2>C</listItem>
+ * ```
+ *
+ * Should become:
+ *
+ * ```xml
+ * <listItem listType="bulleted" listIndent=0>A</listItem>
+ * <listItem listType="bulleted" listIndent=1>BX</listItem>
+ * <listItem listType="bulleted" listIndent=2>Y/listItem>
+ * <listItem listType="bulleted" listIndent=2>C</listItem>
+ * ```
+ */
+export declare const modelIndentPasteFixer: GetCallback<ModelInsertContentEvent>;

package/dist/types/legacylist/legacyindentcommand.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * The list indent command. It is used by the {@link module:list/legacylist~LegacyList legacy list feature}.
+ */
+export default class LegacyIndentCommand extends Command {
+    /**
+     * Determines by how much the command will change the list item's indent attribute.
+     */
+    private readonly _indentBy;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor The editor instance.
+     * @param indentDirection The direction of indent. If it is equal to `backward`, the command will outdent a list item.
+     */
+    constructor(editor: Editor, indentDirection: 'forward' | 'backward');
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Indents or outdents (depending on the {@link #constructor}'s `indentDirection` parameter) selected list items.
+     *
+     * @fires execute
+     */
+    execute(): void;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+}

package/dist/types/legacylist/legacylistcommand.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * The list command. It is used by the {@link module:list/legacylist~LegacyList legacy list feature}.
+ */
+export default class LegacyListCommand extends Command {
+    /**
+     * The type of the list created by the command.
+     */
+    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.
+     *
+     * @readonly
+     */
+    value: boolean;
+    /**
+     * 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');
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the list command.
+     *
+     * @fires execute
+     * @param options Command options.
+     * @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.
+     */
+    execute(options?: {
+        forceValue?: boolean;
+    }): void;
+    /**
+     * Checks the command's {@link #value}.
+     *
+     * @returns The current value.
+     */
+    private _getValue;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+}

package/dist/types/legacylist/legacylistediting.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import LegacyListUtils from './legacylistutils.js';
+import { Plugin } from 'ckeditor5/src/core.js';
+import { Enter } from 'ckeditor5/src/enter.js';
+import { Delete } from 'ckeditor5/src/typing.js';
+import '../../theme/list.css';
+/**
+ * The engine of the list feature. It handles creating, editing and removing lists and list items.
+ *
+ * It registers the `'numberedList'`, `'bulletedList'`, `'indentList'` and `'outdentList'` commands.
+ */
+export default class LegacyListEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "LegacyListEditing";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Enter, typeof Delete, typeof LegacyListUtils];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/legacylist/legacylistutils.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/legacylist/legacylistutils
+ */
+import type { Element, Model, Position } from 'ckeditor5/src/engine.js';
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * A set of helpers related to legacy lists.
+ */
+export default class LegacyListUtils extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "LegacyListUtils";
+    /**
+     * Checks whether the given list-style-type is supported by numbered or bulleted list.
+     */
+    getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;
+    /**
+     * Returns an array with all `listItem` elements in the model selection.
+     *
+     * It returns all the items even if only a part of the list is selected, including items that belong to nested lists.
+     * If no list is selected, it returns an empty array.
+     * The order of the elements is not specified.
+     */
+    getSelectedListItems(model: Model): Array<Element>;
+    /**
+     * Returns an array with all `listItem` elements that represent the same list.
+     *
+     * It means that values of `listIndent`, `listType`, `listStyle`, `listReversed` and `listStart` for all items are equal.
+     *
+     * Additionally, if the `position` is inside a list item, that list item will be returned as well.
+     *
+     * @param position Starting position.
+     * @param direction Walking direction.
+     */
+    getSiblingNodes(position: Position, direction: 'forward' | 'backward'): Array<Element>;
+}

package/dist/types/legacylist/legacyutils.d.ts

@@ -0,0 +1,101 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/legacylist/legacyutils
+ */
+import { type DowncastConversionApi, type DowncastWriter, type Element, type Item, type Model, type Position, type ViewContainerElement, type ViewElement, type ViewItem, type ViewPosition } from 'ckeditor5/src/engine.js';
+/**
+ * Creates a list item {@link module:engine/view/containerelement~ContainerElement}.
+ *
+ * @param writer The writer instance.
+ */
+export declare function createViewListItemElement(writer: DowncastWriter): ViewContainerElement;
+/**
+ * Helper function that creates a `<ul><li></li></ul>` or (`<ol>`) structure out of the given `modelItem` model `listItem` element.
+ * Then, it binds the created view list item (`<li>`) with the model `listItem` element.
+ * The function then returns the created view list item (`<li>`).
+ *
+ * @param modelItem Model list item.
+ * @param conversionApi Conversion interface.
+ * @returns View list element.
+ */
+export declare function generateLiInUl(modelItem: Item, conversionApi: DowncastConversionApi): ViewContainerElement;
+/**
+ * Helper function that inserts a view list at a correct place and merges it with its siblings.
+ * It takes a model list item element (`modelItem`) and a corresponding view list item element (`injectedItem`). The view list item
+ * should be in a view list element (`<ul>` or `<ol>`) and should be its only child.
+ * See comments below to better understand the algorithm.
+ *
+ * @param modelItem Model list item.
+ * @param injectedItem
+ * @param conversionApi Conversion interface.
+ * @param model The model instance.
+ */
+export declare function injectViewList(modelItem: Element, injectedItem: ViewContainerElement, conversionApi: DowncastConversionApi, model: Model): void;
+/**
+ * Helper function that takes two parameters that are expected to be view list elements, and merges them.
+ * The merge happens only if both parameters are list elements of the same type (the same element name and the same class attributes).
+ *
+ * @param viewWriter The writer instance.
+ * @param firstList The first element to compare.
+ * @param secondList The second element to compare.
+ * @returns The position after merge or `null` when there was no merge.
+ */
+export declare function mergeViewLists(viewWriter: DowncastWriter, firstList: ViewItem, secondList: ViewItem): ViewPosition | null;
+/**
+ * Helper function that for a given `view.Position`, returns a `view.Position` that is after all `view.UIElement`s that
+ * are after the given position.
+ *
+ * For example:
+ * `<container:p>foo^<ui:span></ui:span><ui:span></ui:span>bar</container:p>`
+ * For position ^, the position before "bar" will be returned.
+ *
+ */
+export declare function positionAfterUiElements(viewPosition: ViewPosition): ViewPosition;
+/**
+ * Helper function that searches for a previous list item sibling of a given model item that meets the given criteria
+ * passed by the options object.
+ *
+ * @param options Search criteria.
+ * @param options.sameIndent Whether the sought sibling should have the same indentation.
+ * @param options.smallerIndent Whether the sought sibling should have a smaller indentation.
+ * @param options.listIndent The reference indentation.
+ * @param options.direction Walking direction.
+ */
+export declare function getSiblingListItem(modelItem: Item | null, options: {
+    sameIndent?: boolean;
+    smallerIndent?: boolean;
+    listIndent?: number;
+    direction?: 'forward' | 'backward';
+}): Element | null;
+/**
+ * Returns a first list view element that is direct child of the given view element.
+ */
+export declare function findNestedList(viewElement: ViewElement): ViewElement | null;
+/**
+ * Returns an array with all `listItem` elements that represent the same list.
+ *
+ * It means that values of `listIndent`, `listType`, `listStyle`, `listReversed` and `listStart` for all items are equal.
+ *
+ * Additionally, if the `position` is inside a list item, that list item will be returned as well.
+ *
+ * @param position Starting position.
+ * @param direction Walking direction.
+ */
+export declare function getSiblingNodes(position: Position, direction: 'forward' | 'backward'): Array<Element>;
+/**
+ * Returns an array with all `listItem` elements in the model selection.
+ *
+ * It returns all the items even if only a part of the list is selected, including items that belong to nested lists.
+ * If no list is selected, it returns an empty array.
+ * The order of the elements is not specified.
+ *
+ * @internal
+ */
+export declare function getSelectedListItems(model: Model): Array<Element>;
+/**
+ * Checks whether the given list-style-type is supported by numbered or bulleted list.
+ */
+export declare function getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;

package/dist/types/legacylist.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/legacylist
+ */
+import LegacyListEditing from './legacylist/legacylistediting.js';
+import ListUI from './list/listui.js';
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The legacy list feature.
+ *
+ * This is a "glue" plugin that loads the {@link module:list/legacylist/legacylistediting~LegacyListEditing legacy list editing feature}
+ * and {@link module:list/list/listui~ListUI list UI feature}.
+ */
+export default class LegacyList extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof LegacyListEditing, typeof ListUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "LegacyList";
+}