@ckeditor/ckeditor5-list 41.3.0-alpha.3 → 41.3.0

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

@@ -1,220 +0,0 @@
-/**
- * @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';
-/**
- * Map of model attributes applicable to list blocks.
- */
-export interface ListItemAttributesMap {
-    listType?: 'numbered' | 'bulleted' | 'todo';
-    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;
-}
-/**
- * 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

@@ -1,66 +0,0 @@
-/**
- * @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

@@ -1,80 +0,0 @@
-/**
- * @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>];
-};

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

@@ -1,71 +0,0 @@
-/**
- * @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/listsplitcommand
- */
-import type { Element } from 'ckeditor5/src/engine.js';
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-/**
- * The document list split command that splits the list item at the selection.
- *
- * It is used by the {@link module:list/list~List list feature}.
- */
-export default class ListSplitCommand extends Command {
-    /**
-     * Whether list item should be split 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 split before or after the selected block.
-     */
-    constructor(editor: Editor, direction: 'before' | 'after');
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Splits the list item at the selection.
-     *
-     * @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;
-    /**
-     * Returns the model element that is the main focus of the command (according to the current selection and command direction).
-     */
-    private _getStartBlock;
-}
-/**
- * Event fired by the {@link ~ListSplitCommand#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 ~ListSplitCommand#afterExecute
- */
-export type ListSplitCommandAfterExecuteEvent = {
-    name: 'afterExecute';
-    args: [changedBlocks: Array<Element>];
-};

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

@@ -1,23 +0,0 @@
-/**
- * @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';
-/**
- * The list UI feature. It introduces the `'numberedList'` and `'bulletedList'` buttons that
- * allow to convert paragraphs to and from list items and indent or outdent them.
- */
-export default class ListUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

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

@@ -1,50 +0,0 @@
-/**
- * @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/listutils
- */
-import type { Element, Node } from 'ckeditor5/src/engine.js';
-import type { ArrayOrItem } from 'ckeditor5/src/utils.js';
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * A set of helpers related to document lists.
- */
-export default class ListUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListUtils";
-    /**
-     * Expands the given list of selected blocks to include all the items of the lists they're in.
-     *
-     * @param blocks The list of selected blocks.
-     */
-    expandListBlocksToCompleteList(blocks: ArrayOrItem<Element>): Array<Element>;
-    /**
-     * Check if the given block is the first in the list item.
-     *
-     * @param listBlock The list block element.
-     */
-    isFirstBlockOfListItem(listBlock: Element): boolean;
-    /**
-     * Returns true if the given model node is a list item block.
-     *
-     * @param node A model node.
-     */
-    isListItemBlock(node: Node): boolean;
-    /**
-     * Expands the given list of selected blocks to include the leading and tailing blocks of partially selected list items.
-     *
-     * @param blocks The list of selected blocks.
-     * @param options.withNested Whether should include nested list items.
-     */
-    expandListBlocksToCompleteItems(blocks: ArrayOrItem<Element>, options?: {
-        withNested?: boolean;
-    }): Array<Element>;
-}

package/dist/types/list/utils/listwalker.d.ts

@@ -1,149 +0,0 @@
-/**
- * @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/utils/listwalker
- */
-import { type ArrayOrItem } from 'ckeditor5/src/utils.js';
-import { type ListElement } from './model.js';
-import type { Element, Node } from 'ckeditor5/src/engine.js';
-/**
- * Document list blocks iterator.
- */
-export default class ListWalker {
-    /**
-     * The start list item block element.
-     */
-    private _startElement;
-    /**
-     * The reference indent. Initialized by the indent of the start block.
-     */
-    private _referenceIndent;
-    /**
-     * The iterating direction.
-     */
-    private _isForward;
-    /**
-     * Whether start block should be included in the result (if it's matching other criteria).
-     */
-    private _includeSelf;
-    /**
-     * Additional attributes that must be the same for each block.
-     */
-    private _sameAttributes;
-    /**
-     * Whether blocks with the same indent level as the start block should be included in the result.
-     */
-    private _sameIndent;
-    /**
-     * Whether blocks with a lower indent level than the start block should be included in the result.
-     */
-    private _lowerIndent;
-    /**
-     * Whether blocks with a higher indent level than the start block should be included in the result.
-     */
-    private _higherIndent;
-    /**
-     * Creates a document list iterator.
-     *
-     * @param startElement The start list item block element.
-     * @param options.direction The iterating direction.
-     * @param options.includeSelf Whether start block should be included in the result (if it's matching other criteria).
-     * @param options.sameAttributes Additional attributes that must be the same for each block.
-     * @param options.sameIndent Whether blocks with the same indent level as the start block should be included
-     * in the result.
-     * @param options.lowerIndent Whether blocks with a lower indent level than the start block should be included
-     * in the result.
-     * @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;
-    });
-    /**
-     * Performs only first step of iteration and returns the result.
-     *
-     * @param startElement The start list item block element.
-     * @param options.direction The iterating direction.
-     * @param options.includeSelf Whether start block should be included in the result (if it's matching other criteria).
-     * @param options.sameAttributes Additional attributes that must be the same for each block.
-     * @param options.sameIndent Whether blocks with the same indent level as the start block should be included
-     * in the result.
-     * @param options.lowerIndent Whether blocks with a lower indent level than the start block should be included
-     * in the result.
-     * @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;
-    /**
-     * Iterable interface.
-     */
-    [Symbol.iterator](): Iterator<ListElement>;
-    /**
-     * Returns the model element to start iterating.
-     */
-    private _getStartNode;
-}
-/**
- * Iterates sibling list blocks starting from the given node.
- *
- * @internal
- * @param node The model node.
- * @param direction Iteration direction.
- * @returns The object with `node` and `previous` {@link module:engine/model/element~Element blocks}.
- */
-export declare function iterateSiblingListBlocks(node: Node | null, direction?: 'forward' | 'backward'): IterableIterator<ListIteratorValue>;
-/**
- * The iterable protocol over the list elements.
- *
- * @internal
- */
-export declare class ListBlocksIterable {
-    private _listHead;
-    /**
-     * @param listHead The head element of a list.
-     */
-    constructor(listHead: Element);
-    /**
-     * List blocks iterator.
-     *
-     * Iterates over all blocks of a list.
-     */
-    [Symbol.iterator](): Iterator<ListIteratorValue>;
-}
-/**
- * Object returned by `iterateSiblingListBlocks()` when traversing a list.
- *
- * @internal
- */
-export interface ListIteratorValue {
-    /**
-     * The current list node.
-     */
-    node: ListElement;
-    /**
-     * The previous list node.
-     */
-    previous: ListElement | null;
-    /**
-     * The previous list node at the same indent as current node.
-     */
-    previousNodeInList: ListElement | null;
-}