@ckeditor/ckeditor5-list 41.3.1 → 41.4.0

package/dist/types/legacytodolist/legacytodolistediting.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @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
+ */
+/**
+ * @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 { Plugin } from 'ckeditor5/src/core.js';
+import LegacyListEditing from '../legacylist/legacylistediting.js';
+/**
+ * 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/legacylist/legacylistediting~LegacyListEditing legacy list editing
+ * plugin} and extends it with the commands:
+ *
+ * - `'todoList'`,
+ * - `'checkTodoList'`,
+ * - `'todoListCheck'` as an alias for `checkTodoList` command.
+ */
+export default class LegacyTodoListEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "LegacyTodoListEditing";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof LegacyListEditing];
+    /**
+     * @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;
+    /**
+     * Observe when user enters or leaves todo list and set proper aria value in global live announcer.
+     * This allows screen readers to indicate when the user has entered and left the specified todo list.
+     *
+     * @internal
+     */
+    private _initAriaAnnouncements;
+}

package/dist/types/legacytodolist.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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
+ */
+/**
+ * @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/legacytodolist
+ */
+import LegacyTodoListEditing from './legacytodolist/legacytodolistediting.js';
+import TodoListUI from './todolist/todolistui.js';
+import { Plugin } from 'ckeditor5/src/core.js';
+import '../theme/todolist.css';
+/**
+ * The legacy to-do list feature.
+ *
+ * This is a "glue" plugin that loads the {@link module:list/legacytodolist/legacytodolistediting~LegacyTodoListEditing legacy to-do list
+ * editing feature} and the {@link module:list/todolist/todolistui~TodoListUI to-do list UI feature}.
+ */
+export default class LegacyTodoList extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof LegacyTodoListEditing, typeof TodoListUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "LegacyTodoList";
+}

package/dist/types/list/adjacentlistssupport.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @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
+ */
+/**
+ * @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 { Plugin } from 'ckeditor5/src/core.js';
+export default class AdjacentListsSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "AdjacentListsSupport";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/dist/types/list/converters.d.ts

@@ -0,0 +1,77 @@
+/**
+ * @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
+ */
+/**
+ * @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/list/converters
+ */
+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';
+/**
+ * Returns the upcast converter for list items. It's supposed to work after the block converters (content inside list items) are converted.
+ *
+ * @internal
+ */
+export declare function listItemUpcastConverter(): GetCallback<UpcastElementEvent>;
+/**
+ * Returns the upcast 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,
+ * incorrect data can also be cleared if the view was incorrect.
+ *
+ * @internal
+ */
+export declare function listUpcastCleanList(): GetCallback<UpcastElementEvent>;
+/**
+ * Returns a model document change:data event listener that triggers conversion of related items if needed.
+ *
+ * @internal
+ * @param model The editor model.
+ * @param editing The editing controller.
+ * @param attributeNames The list of all model list attributes (including registered strategies).
+ * @param listEditing The document list editing plugin.
+ */
+export declare function reconvertItemsOnDataChange(model: Model, editing: EditingController, attributeNames: Array<string>, listEditing: ListEditing): () => void;
+/**
+ * Returns the list item downcast converter.
+ *
+ * @internal
+ * @param attributeNames A list of attribute names that should be converted if they are set.
+ * @param strategies The strategies.
+ * @param model The model.
+ */
+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.
+ *
+ * @internal
+ * @param attributeNames The list of all model list attributes (including registered strategies).
+ */
+export declare function bogusParagraphCreator(attributeNames: Array<string>, { dataPipeline }?: {
+    dataPipeline?: boolean;
+}): ElementCreatorFunction;
+/**
+ * Helper for mapping mode to view elements. It's using positions mapping instead of mapper.toViewElement( element )
+ * to find outermost view element. This is for cases when mapping is using inner view element like in the code blocks (pre > code).
+ *
+ * @internal
+ * @param element The model element.
+ * @param mapper The mapper instance.
+ * @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/dist/types/list/listcommand.d.ts

@@ -0,0 +1,96 @@
+/**
+ * @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
+ */
+/**
+ * @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/list/listcommand
+ */
+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}.
+ */
+export default class ListCommand extends Command {
+    /**
+     * The type of the list created by the command.
+     */
+    readonly type: ListType;
+    /**
+     * A flag indicating whether the command is active, which means that the selection starts in a list of the same type.
+     *
+     * @observable
+     * @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: ListType, options?: {
+        multiLevel?: boolean;
+    });
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the list command.
+     *
+     * @fires execute
+     * @fires afterExecute
+     * @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.
+     * @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.
+     *
+     * @param changedBlocks The changed list elements.
+     */
+    private _fireAfterExecute;
+    /**
+     * 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;
+}
+/**
+ * Event fired by the {@link ~ListCommand#execute} method.
+ *
+ * It allows to execute an action after executing the {@link ~ListCommand#execute} method,
+ * for example adjusting attributes of changed list items.
+ *
+ * @internal
+ * @eventName ~ListCommand#afterExecute
+ */
+export type ListCommandAfterExecuteEvent = {
+    name: 'afterExecute';
+    args: [changedBlocks: Array<Element>];
+};

package/dist/types/list/listediting.d.ts

@@ -0,0 +1,226 @@
+/**
+ * @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
+ */
+/**
+ * @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/list/listediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import type { DowncastWriter, Element, ViewElement, ViewAttributeElement, Writer } from 'ckeditor5/src/engine.js';
+import { Delete } from 'ckeditor5/src/typing.js';
+import { Enter } from 'ckeditor5/src/enter.js';
+import ListUtils from './listutils.js';
+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?: ListType;
+    listIndent?: number;
+    listItemId?: string;
+}
+/**
+ * The editing part of the document-list feature. It handles creating, editing and removing lists and list items.
+ */
+export default class ListEditing extends Plugin {
+    /**
+     * The list of registered downcast strategies.
+     */
+    private readonly _downcastStrategies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ListEditing";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Enter, typeof Delete, typeof ListUtils, typeof ClipboardPipeline];
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Registers a downcast strategy.
+     *
+     * **Note**: Strategies must be registered in the `Plugin#init()` phase so that it can be applied
+     * in the `ListEditing#afterInit()`.
+     *
+     * @param strategy The downcast strategy to register.
+     */
+    registerDowncastStrategy(strategy: DowncastStrategy): void;
+    /**
+     * Returns list of model attribute names that should affect downcast conversion.
+     */
+    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.
+     */
+    private _setupDeleteIntegration;
+    /**
+     * Attaches a listener to the {@link module:engine/view/document~Document#event:enter} event and handles enter key press
+     * in document lists.
+     */
+    private _setupEnterIntegration;
+    /**
+     * Attaches a listener to the {@link module:engine/view/document~Document#event:tab} event and handles tab key and tab+shift keys
+     * presses in document lists.
+     */
+    private _setupTabIntegration;
+    /**
+     * Registers the conversion helpers for the document-list feature.
+     */
+    private _setupConversion;
+    /**
+     * Registers model post-fixers.
+     */
+    private _setupModelPostFixing;
+    /**
+     * Integrates the feature with the clipboard via {@link module:engine/model/model~Model#insertContent} and
+     * {@link module:engine/model/model~Model#getSelectedContent}.
+     */
+    private _setupClipboardIntegration;
+    /**
+     * Informs editor accessibility features about keystrokes brought by the plugin.
+     */
+    private _setupAccessibilityIntegration;
+}
+/**
+ * The attribute to attribute downcast strategy for UL, OL, LI elements.
+ */
+export interface AttributeDowncastStrategy {
+    /**
+     * The scope of the downcast (whether it applies to LI or OL/UL).
+     */
+    scope: 'list' | 'item';
+    /**
+     * The model attribute name.
+     */
+    attributeName: string;
+    /**
+     * Sets the property on the view element.
+     */
+    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;
+    /**
+     * 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.
+ */
+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.
+ *
+ * It allows triggering a re-wrapping of a list item.
+ *
+ * @internal
+ * @eventName ~ListEditing#postFixer
+ * @param listHead The head element of a list.
+ * @param writer The writer to do changes with.
+ * @param seenIds The set of already known IDs.
+ * @returns If a post-fixer made a change of the model tree, it should return `true`.
+ */
+export type ListEditingPostFixerEvent = {
+    name: 'postFixer';
+    args: [
+        {
+            listNodes: ListBlocksIterable;
+            listHead: Element;
+            writer: Writer;
+            seenIds: Set<string>;
+        }
+    ];
+    return: boolean;
+};
+/**
+ * Event fired on changes detected on the model list element to verify if the view representation of a list element
+ * is representing those attributes.
+ *
+ * It allows triggering a re-wrapping of a list item.
+ *
+ * **Note**: For convenience this event is namespaced and could be captured as `checkAttributes:list` or `checkAttributes:item`.
+ *
+ * @internal
+ * @eventName ~ListEditing#checkAttributes
+ */
+export type ListEditingCheckAttributesEvent = {
+    name: 'checkAttributes' | 'checkAttributes:list' | 'checkAttributes:item';
+    args: [
+        {
+            viewElement: ViewElement & {
+                id?: string;
+            };
+            modelAttributes: ListItemAttributesMap;
+        }
+    ];
+    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 ~ListEditing#checkElement
+ */
+export type ListEditingCheckElementEvent = {
+    name: 'checkElement';
+    args: [
+        {
+            viewElement: ViewElement;
+            modelElement: Element;
+        }
+    ];
+    return: boolean;
+};

package/dist/types/list/listindentcommand.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @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
+ */
+/**
+ * @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/list/listindentcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+import type { Element } from 'ckeditor5/src/engine.js';
+/**
+ * The document list indent command. It is used by the {@link module:list/list~List list feature}.
+ */
+export default class ListIndentCommand extends Command {
+    /**
+     * Determines by how much the command will change the list item's indent attribute.
+     */
+    private readonly _direction;
+    /**
+     * 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
+     * @fires afterExecute
+     */
+    execute(): void;
+    /**
+     * Fires the `afterExecute` event.
+     *
+     * @param changedBlocks The changed list elements.
+     */
+    private _fireAfterExecute;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+}
+/**
+ * Event fired by the {@link ~ListIndentCommand#execute} method.
+ *
+ * It allows to execute an action after executing the {@link module:list/list/listcommand~ListCommand#execute}
+ * method, for example adjusting attributes of changed list items.
+ *
+ * @internal
+ * @eventName ~ListIndentCommand#afterExecute
+ */
+export type ListIndentCommandAfterExecuteEvent = {
+    name: 'afterExecute';
+    args: [changedBlocks: Array<Element>];
+};

package/dist/types/list/listmergecommand.d.ts

@@ -0,0 +1,80 @@
+/**
+ * @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
+ */
+/**
+ * @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/list/listmergecommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+import type { Element } from 'ckeditor5/src/engine.js';
+/**
+ * The document list merge command. It is used by the {@link module:list/list~List list feature}.
+ */
+export default class ListMergeCommand extends Command {
+    /**
+     * Whether list item should be merged before or after the selected block.
+     */
+    private readonly _direction;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor The editor instance.
+     * @param direction Whether list item should be merged before or after the selected block.
+     */
+    constructor(editor: Editor, direction: 'forward' | 'backward');
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Merges list blocks together (depending on the {@link #constructor}'s `direction` parameter).
+     *
+     * @fires execute
+     * @fires afterExecute
+     * @param options Command options.
+     * @param options.shouldMergeOnBlocksContentLevel When set `true`, merging will be performed together
+     * with {@link module:engine/model/model~Model#deleteContent} to get rid of the inline content in the selection or take advantage
+     * of the heuristics in `deleteContent()` that helps convert lists into paragraphs in certain cases.
+     */
+    execute({ shouldMergeOnBlocksContentLevel }?: {
+        shouldMergeOnBlocksContentLevel?: boolean;
+    }): void;
+    /**
+     * Fires the `afterExecute` event.
+     *
+     * @param changedBlocks The changed list elements.
+     */
+    private _fireAfterExecute;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+    /**
+     * Returns the boundary elements the merge should be executed for. These are not necessarily selection's first
+     * and last position parents but sometimes sibling or even further blocks depending on the context.
+     *
+     * @param selection The selection the merge is executed for.
+     * @param shouldMergeOnBlocksContentLevel When `true`, merge is performed together with
+     * {@link module:engine/model/model~Model#deleteContent} to remove the inline content within the selection.
+     */
+    private _getMergeSubjectElements;
+}
+/**
+ * Event fired by the {@link ~ListMergeCommand#execute} method.
+ *
+ * It allows to execute an action after executing the {@link module:list/list/listcommand~ListCommand#execute}
+ * method, for example adjusting attributes of changed list items.
+ *
+ * @internal
+ * @eventName ~ListMergeCommand#afterExecute
+ */
+export type ListMergeCommandAfterExecuteEvent = {
+    name: 'afterExecute';
+    args: [changedBlocks: Array<Element>];
+};