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

package/dist/list/listmergecommand.d.ts

@@ -1,76 +1,76 @@
 /**
- * @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/listmergecommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import type { ModelElement } from '@ckeditor/ckeditor5-engine';
+* @module list/list/listmergecommand
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
+import type { ModelElement } from "@ckeditor/ckeditor5-engine";
 /**
- * The document list merge command. It is used by the {@link module:list/list~List list feature}.
- */
+* The document list merge command. It is used by the {@link module:list/list~List list feature}.
+*/
 export declare 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;
+	/**
+	* 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
+	*/
+	override 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.
+	*/
+	override 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
- */
+* 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<ModelElement>];
+	name: "afterExecute";
+	args: [changedBlocks: Array<ModelElement>];
 };

package/dist/list/listsplitcommand.d.ts

@@ -1,67 +1,67 @@
 /**
- * @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/listsplitcommand
- */
-import type { ModelElement } from '@ckeditor/ckeditor5-engine';
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+* @module list/list/listsplitcommand
+*/
+import type { ModelElement } from "@ckeditor/ckeditor5-engine";
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
 /**
- * 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}.
- */
+* 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 declare 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;
+	/**
+	* 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
+	*/
+	override refresh(): void;
+	/**
+	* Splits the list item at the selection.
+	*
+	* @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;
+	/**
+	* 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
- */
+* 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<ModelElement>];
+	name: "afterExecute";
+	args: [changedBlocks: Array<ModelElement>];
 };

package/dist/list/listui.d.ts

@@ -1,23 +1,23 @@
 /**
- * @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
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+* @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
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
 /**
- * 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.
- */
+* 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 declare class ListUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ListUI";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/list/listutils.d.ts

@@ -1,60 +1,60 @@
 /**
- * @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/listutils
- */
-import type { ModelElement, ModelNode } from '@ckeditor/ckeditor5-engine';
-import type { ArrayOrItem } from '@ckeditor/ckeditor5-utils';
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { type ListElement } from './utils/model.js';
-import type { ListType } from './listediting.js';
+* @module list/list/listutils
+*/
+import type { ModelElement, ModelNode } from "@ckeditor/ckeditor5-engine";
+import type { ArrayOrItem } from "@ckeditor/ckeditor5-utils";
+import { Plugin } from "@ckeditor/ckeditor5-core";
+import { type ListElement } from "./utils/model.js";
+import type { ListType } from "./listediting.js";
 /**
- * A set of helpers related to document lists.
- */
+* A set of helpers related to document lists.
+*/
 export declare class ListUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListUtils";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * 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<ModelElement>): Array<ModelElement>;
-    /**
-     * Check if the given block is the first in the list item.
-     *
-     * @param listBlock The list block element.
-     */
-    isFirstBlockOfListItem(listBlock: ModelElement): boolean;
-    /**
-     * Returns true if the given model node is a list item block.
-     *
-     * @param node A model node.
-     */
-    isListItemBlock(node: ModelNode | null): node is ListElement;
-    /**
-     * 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<ModelElement>, options?: {
-        withNested?: boolean;
-    }): Array<ModelElement>;
-    /**
-     * Returns true if listType is of type `numbered` or `customNumbered`.
-     */
-    isNumberedListType(listType: ListType): boolean;
-    /**
-     * Returns true if the given list item is the first item in the list.
-     */
-    isFirstListItemInList(listItem: ModelElement): boolean;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ListUtils";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* 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<ModelElement>): Array<ModelElement>;
+	/**
+	* Check if the given block is the first in the list item.
+	*
+	* @param listBlock The list block element.
+	*/
+	isFirstBlockOfListItem(listBlock: ModelElement): boolean;
+	/**
+	* Returns true if the given model node is a list item block.
+	*
+	* @param node A model node.
+	*/
+	isListItemBlock(node: ModelNode | null): node is ListElement;
+	/**
+	* 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<ModelElement>, options?: {
+		withNested?: boolean;
+	}): Array<ModelElement>;
+	/**
+	* Returns true if listType is of type `numbered` or `customNumbered`.
+	*/
+	isNumberedListType(listType: ListType): boolean;
+	/**
+	* Returns true if the given list item is the first item in the list.
+	*/
+	isFirstListItemInList(listItem: ModelElement): boolean;
 }