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

package/dist/legacytodolist.d.ts

@@ -1,31 +1,31 @@
 /**
- * @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/legacytodolist
- */
-import { LegacyTodoListEditing } from './legacytodolist/legacytodolistediting.js';
-import { TodoListUI } from './todolist/todolistui.js';
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import '../theme/todolist.css';
+* @module list/legacytodolist
+*/
+import { LegacyTodoListEditing } from "./legacytodolist/legacytodolistediting.js";
+import { TodoListUI } from "./todolist/todolistui.js";
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+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}.
- */
+* 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 declare class LegacyTodoList extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof LegacyTodoListEditing, typeof TodoListUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "LegacyTodoList";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[LegacyTodoListEditing, TodoListUI]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "LegacyTodoList";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
 }

package/dist/list/adjacentlistssupport.d.ts

@@ -1,19 +1,19 @@
 /**
- * @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";
 export declare class AdjacentListsSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AdjacentListsSupport";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AdjacentListsSupport";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/list/converters.d.ts

@@ -1,88 +1,88 @@
 /**
- * @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/converters
- */
-import { type DowncastAttributeEvent, type ViewDowncastWriter, type EditingController, type ModelElement, type DowncastElementCreatorFunction, type Mapper, type Model, type UpcastElementEvent, type ViewElement, type DowncastRemoveEvent, type EditingView, type MapperModelToViewPositionEvent, type ModelSchema } from '@ckeditor/ckeditor5-engine';
-import type { GetCallback } from '@ckeditor/ckeditor5-utils';
-import { type ListElement } from './utils/model.js';
-import type { ListEditing, ListDowncastStrategy } from './listediting.js';
+* @module list/list/converters
+*/
+import { type DowncastAttributeEvent, type ViewDowncastWriter, type EditingController, type ModelElement, type DowncastElementCreatorFunction, type Mapper, type Model, type UpcastElementEvent, type ViewElement, type DowncastRemoveEvent, type EditingView, type MapperModelToViewPositionEvent, type ModelSchema } from "@ckeditor/ckeditor5-engine";
+import type { GetCallback } from "@ckeditor/ckeditor5-utils";
+import { type ListElement } from "./utils/model.js";
+import type { ListEditing, ListDowncastStrategy } from "./listediting.js";
 /**
- * Returns a consuming upcast converter for skip-level list item wrappers. It detects intermediate `<li>` elements
- * with `list-style-type:none` (generated by the skip-level downcast or by external sources) and consumes them
- * without producing a model element, so they don't end up as empty list items in the model.
- *
- * The wrapper `<li>` is consumed, but its children (nested lists) are converted normally. Because `getIndent()`
- * counts all ancestor `<li>` elements (including the consumed wrapper), nested items receive the correct indent
- * values that reflect the skip-level gap.
- *
- * Only `<li>` elements whose sole meaningful content is a nested `<ul>`/`<ol>` are treated as intermediate wrappers.
- * Anything else (text, paragraphs, custom elements, even an empty `<li>` with `list-style-type:none` carrying only
- * attributes) falls through to the regular list item upcast, so its data and attributes can be preserved by GHS
- * or other plugins.
- *
- * @internal
- */
+* Returns a consuming upcast converter for skip-level list item wrappers. It detects intermediate `<li>` elements
+* with `list-style-type:none` (generated by the skip-level downcast or by external sources) and consumes them
+* without producing a model element, so they don't end up as empty list items in the model.
+*
+* The wrapper `<li>` is consumed, but its children (nested lists) are converted normally. Because `getIndent()`
+* counts all ancestor `<li>` elements (including the consumed wrapper), nested items receive the correct indent
+* values that reflect the skip-level gap.
+*
+* Only `<li>` elements whose sole meaningful content is a nested `<ul>`/`<ol>` are treated as intermediate wrappers.
+* Anything else (text, paragraphs, custom elements, even an empty `<li>` with `list-style-type:none` carrying only
+* attributes) falls through to the regular list item upcast, so its data and attributes can be preserved by GHS
+* or other plugins.
+*
+* @internal
+*/
 export declare function listItemSkipLevelConsumer(): GetCallback<UpcastElementEvent>;
 /**
- * Returns the upcast converter for list items. It's supposed to work after the block converters (content inside list items) are converted.
- *
- * @internal
- */
+* 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 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.
- */
+* 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.
- */
+* 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<ListDowncastStrategy>, model: Model, { dataPipeline, enableSkipLevelLists }: {
-    dataPipeline?: boolean;
-    enableSkipLevelLists?: boolean;
+	dataPipeline?: boolean;
+	enableSkipLevelLists?: boolean;
 }): GetCallback<DowncastAttributeEvent<ListElement>>;
 /**
- * The 'remove' downcast converter for custom markers.
- *
- * @internal
- */
+* The 'remove' downcast converter for custom markers.
+*
+* @internal
+*/
 export declare function listItemDowncastRemoveConverter(schema: ModelSchema): 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).
- */
+* 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;
+	dataPipeline?: boolean;
 }): DowncastElementCreatorFunction;
 /**
- * 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.
- * @param writer The view downcast writer.
- */
+* 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.
+* @param writer The view downcast writer.
+*/
 export declare function findMappedViewElement(element: ModelElement, mapper: Mapper, model: Model, writer: ViewDowncastWriter): ViewElement | undefined;
 /**
- * The model to view custom position mapping for cases when marker is injected at the beginning of a block.
- *
- * @internal
- */
+* The model to view custom position mapping for cases when marker is injected at the beginning of a block.
+*
+* @internal
+*/
 export declare function createModelToViewPositionMapper(strategies: Array<ListDowncastStrategy>, view: EditingView): GetCallback<MapperModelToViewPositionEvent>;

package/dist/list/listcommand.d.ts

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