@ckeditor/ckeditor5-list 48.2.0 → 48.3.0-alpha.0

package/dist/list/listediting.d.ts

@@ -1,244 +1,238 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module list/list/listediting
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import type { ViewDowncastWriter, ModelElement, ViewElement, ViewAttributeElement, ModelWriter } from '@ckeditor/ckeditor5-engine';
-import { Delete } from '@ckeditor/ckeditor5-typing';
-import { Enter } from '@ckeditor/ckeditor5-enter';
-import { ListFormatting } from '../listformatting.js';
-import { ListUtils } from './listutils.js';
-import { type ListElement } from './utils/model.js';
-import { ListBlocksIterable } from './utils/listwalker.js';
-import { ClipboardPipeline } from '@ckeditor/ckeditor5-clipboard';
-import '../../theme/documentlist.css';
-import '../../theme/list.css';
-export type ListType = 'numbered' | 'bulleted' | 'todo' | 'customNumbered' | 'customBulleted';
+* @module list/list/listediting
+*/
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import type { ViewDowncastWriter, ModelElement, ViewElement, ViewAttributeElement, ModelWriter } from "@ckeditor/ckeditor5-engine";
+import { Delete } from "@ckeditor/ckeditor5-typing";
+import { Enter } from "@ckeditor/ckeditor5-enter";
+import { ListFormatting } from "../listformatting.js";
+import { ListUtils } from "./listutils.js";
+import { type ListElement } from "./utils/model.js";
+import { ListBlocksIterable } from "./utils/listwalker.js";
+import { ClipboardPipeline } from "@ckeditor/ckeditor5-clipboard";
+import "../../theme/documentlist.css";
+import "../../theme/list.css";
+export type ListType = "numbered" | "bulleted" | "todo" | "customNumbered" | "customBulleted";
 /**
- * Map of model attributes applicable to list blocks.
- */
+* Map of model attributes applicable to list blocks.
+*/
 export interface ListItemAttributesMap {
-    listType?: ListType;
-    listIndent?: number;
-    listItemId?: string;
+	listType?: ListType;
+	listIndent?: number;
+	listItemId?: string;
 }
 /**
- * The editing part of the document-list feature. It handles creating, editing and removing lists and list items.
- */
+* The editing part of the document-list feature. It handles creating, editing and removing lists and list items.
+*/
 export declare class ListEditing extends Plugin {
-    /**
-     * The list of registered downcast strategies.
-     */
-    private readonly _downcastStrategies;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Enter, typeof Delete, typeof ListUtils, typeof ClipboardPipeline, typeof ListFormatting];
-    /**
-     * @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: ListDowncastStrategy): 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~ViewDocument#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~ViewDocument#event:enter} event and handles enter key press
-     * in document lists.
-     */
-    private _setupEnterIntegration;
-    /**
-     * Attaches a listener to the {@link module:engine/view/document~ViewDocument#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;
-    /**
-     * Convert `listItemId` attribute to `data-list-item-id` attribute on the view element in both downcast pipelines.
-     */
-    private _setupListItemIdConversionStrategy;
+	/**
+	* The list of registered downcast strategies.
+	*/
+	private readonly _downcastStrategies;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ListEditing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Enter, Delete, ListUtils, ClipboardPipeline, ListFormatting]>;
+	/**
+	* @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: ListDowncastStrategy): 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~ViewDocument#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~ViewDocument#event:enter} event and handles enter key press
+	* in document lists.
+	*/
+	private _setupEnterIntegration;
+	/**
+	* Attaches a listener to the {@link module:engine/view/document~ViewDocument#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;
+	/**
+	* Convert `listItemId` attribute to `data-list-item-id` attribute on the view element in both downcast pipelines.
+	*/
+	private _setupListItemIdConversionStrategy;
 }
 /**
- * The attribute to attribute downcast strategy for UL, OL, LI elements.
- */
+* The attribute to attribute downcast strategy for UL, OL, LI elements.
+*/
 export interface ListAttributeDowncastStrategy {
-    /**
-     * The scope of the downcast (whether it applies to LI or OL/UL).
-     */
-    scope: 'list' | 'item';
-    /**
-     * The model attribute name.
-     */
-    attributeName: string;
-    /**
-     * Whether the attribute should be consumed or this strategy is a side effect.
-     *
-     * @default true
-     */
-    consume?: boolean;
-    /**
-     * Sets the property on the view element.
-     */
-    setAttributeOnDowncast(writer: ViewDowncastWriter, value: unknown, element: ViewElement, options: Record<string, unknown>, modelElement: ModelElement): void;
+	/**
+	* The scope of the downcast (whether it applies to LI or OL/UL).
+	*/
+	scope: "list" | "item";
+	/**
+	* The model attribute name.
+	*/
+	attributeName: string;
+	/**
+	* Whether the attribute should be consumed or this strategy is a side effect.
+	*
+	* @default true
+	*/
+	consume?: boolean;
+	/**
+	* Sets the property on the view element.
+	*/
+	setAttributeOnDowncast(writer: ViewDowncastWriter, value: unknown, element: ViewElement, options: Record<string, unknown>, modelElement: ModelElement): void;
 }
 /**
- * The custom marker downcast strategy.
- */
+* The custom marker downcast strategy.
+*/
 export interface ListItemMarkerDowncastStrategy {
-    /**
-     * The scope of the downcast.
-     */
-    scope: 'itemMarker';
-    /**
-     * The model attribute name.
-     */
-    attributeName: string;
-    /**
-     * Whether the attribute should be consumed or this strategy is a side effect.
-     *
-     * @default true
-     */
-    consume?: boolean;
-    /**
-     * Creates a view element for a custom item marker.
-     */
-    createElement(writer: ViewDowncastWriter, modelElement: ModelElement, { dataPipeline }: {
-        dataPipeline?: boolean;
-    }): ViewElement | null;
-    /**
-     * Creates an ViewAttributeElement to be used for wrapping a first block of a list item.
-     */
-    createWrapperElement?(writer: ViewDowncastWriter, modelElement: ModelElement, { 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: ModelElement): 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: ModelElement): boolean;
+	/**
+	* The scope of the downcast.
+	*/
+	scope: "itemMarker";
+	/**
+	* The model attribute name.
+	*/
+	attributeName: string;
+	/**
+	* Whether the attribute should be consumed or this strategy is a side effect.
+	*
+	* @default true
+	*/
+	consume?: boolean;
+	/**
+	* Creates a view element for a custom item marker.
+	*/
+	createElement(writer: ViewDowncastWriter, modelElement: ModelElement, { dataPipeline }: {
+		dataPipeline?: boolean;
+	}): ViewElement | null;
+	/**
+	* Creates an ViewAttributeElement to be used for wrapping a first block of a list item.
+	*/
+	createWrapperElement?(writer: ViewDowncastWriter, modelElement: ModelElement, { 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: ModelElement): 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: ModelElement): boolean;
 }
 /**
- * The downcast strategy.
- */
+* The downcast strategy.
+*/
 export type ListDowncastStrategy = ListAttributeDowncastStrategy | ListItemMarkerDowncastStrategy;
 /**
- * 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.
- *
- * @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`.
- */
+* 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.
+*
+* @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: ModelElement;
-            writer: ModelWriter;
-            seenIds: Set<string>;
-        }
-    ];
-    return: boolean;
+	name: "postFixer";
+	args: [{
+		listNodes: ListBlocksIterable;
+		listHead: ModelElement;
+		writer: ModelWriter;
+		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
- */
+* 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;
-            modelReferenceElement: ListElement;
-        }
-    ];
-    return: boolean;
+	name: "checkAttributes" | "checkAttributes:list" | "checkAttributes:item";
+	args: [{
+		viewElement: ViewElement & {
+			id?: string;
+		};
+		modelAttributes: ListItemAttributesMap;
+		modelReferenceElement: ListElement;
+	}];
+	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
- */
+* 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: ModelElement;
-        }
-    ];
-    return: boolean;
+	name: "checkElement";
+	args: [{
+		viewElement: ViewElement;
+		modelElement: ModelElement;
+	}];
+	return: boolean;
 };

package/dist/list/listindentcommand.d.ts

@@ -1,62 +1,62 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module list/list/listindentcommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import type { ModelElement } from '@ckeditor/ckeditor5-engine';
+* @module list/list/listindentcommand
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
+import type { ModelElement } from "@ckeditor/ckeditor5-engine";
 /**
- * The document list indent command. It is used by the {@link module:list/list~List list feature}.
- */
+* The document list indent command. It is used by the {@link module:list/list~List list feature}.
+*/
 export declare 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;
+	/**
+	* 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
+	*/
+	override refresh(): void;
+	/**
+	* Indents or outdents (depending on the {@link #constructor}'s `indentDirection` parameter) selected list items.
+	*
+	* @fires execute
+	* @fires afterExecute
+	*/
+	override 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
- */
+* 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<ModelElement>];
+	name: "afterExecute";
+	args: [changedBlocks: Array<ModelElement>];
 };