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

package/dist/legacylistproperties/legacyliststartcommand.d.ts

@@ -1,38 +1,38 @@
 /**
- * @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/legacylistproperties/legacyliststartcommand
- */
-import { Command } from '@ckeditor/ckeditor5-core';
+* @module list/legacylistproperties/legacyliststartcommand
+*/
+import { Command } from "@ckeditor/ckeditor5-core";
 /**
- * The list start index command. It changes the `listStart` attribute of the selected list items.
- * It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
- */
+* The list start index command. It changes the `listStart` attribute of the selected list items.
+* It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
+*/
 export declare class LegacyListStartCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    value: number | null;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options Execute options.
-     * @param options.startIndex The list start index.
-     */
-    execute({ startIndex }?: {
-        startIndex?: number;
-    }): void;
-    /**
-     * Checks the command's {@link #value}.
-     *
-     * @returns The current value.
-     */
-    private _getValue;
+	/**
+	* @inheritDoc
+	*/
+	value: number | null;
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command.
+	*
+	* @fires execute
+	* @param options Execute options.
+	* @param options.startIndex The list start index.
+	*/
+	override execute({ startIndex }?: {
+		startIndex?: number;
+	}): void;
+	/**
+	* Checks the command's {@link #value}.
+	*
+	* @returns The current value.
+	*/
+	private _getValue;
 }

package/dist/legacylistproperties/legacyliststylecommand.d.ts

@@ -1,68 +1,68 @@
 /**
- * @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/legacylistproperties/legacyliststylecommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+* @module list/legacylistproperties/legacyliststylecommand
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
 /**
- * The list style command. It changes the `listStyle` attribute of the selected list items.
- *
- * If the list type (numbered or bulleted) can be inferred from the passed style type,
- * the command tries to convert selected items to a list of that type.
- * It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
- */
+* The list style command. It changes the `listStyle` attribute of the selected list items.
+*
+* If the list type (numbered or bulleted) can be inferred from the passed style type,
+* the command tries to convert selected items to a list of that type.
+* It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
+*/
 export declare class LegacyListStyleCommand extends Command {
-    isStyleTypeSupported: undefined;
-    /**
-     * @inheritDoc
-     * @readonly
-     */
-    value: string | null;
-    /**
-     * The default type of the list style.
-     */
-    readonly defaultType: string;
-    /**
-     * Creates an instance of the command.
-     *
-     * @param editor The editor instance.
-     * @param defaultType The list type that will be used by default if the value was not specified during
-     * the command execution.
-     */
-    constructor(editor: Editor, defaultType: string);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.type The type of the list style, e.g. `'disc'` or `'square'`. If `null` is specified, the default
-     * style will be applied.
-     */
-    execute(options?: {
-        type?: string | null;
-    }): void;
-    /**
-     * 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;
-    /**
-     * Checks if the provided list style is valid. Also changes the selection to a list if it's not set yet.
-     *
-     * @param options Additional options.
-     * @param options.type The type of the list style. If `null` is specified, the function does nothing.
-    */
-    private _tryToConvertItemsToList;
+	isStyleTypeSupported: undefined;
+	/**
+	* @inheritDoc
+	* @readonly
+	*/
+	value: string | null;
+	/**
+	* The default type of the list style.
+	*/
+	readonly defaultType: string;
+	/**
+	* Creates an instance of the command.
+	*
+	* @param editor The editor instance.
+	* @param defaultType The list type that will be used by default if the value was not specified during
+	* the command execution.
+	*/
+	constructor(editor: Editor, defaultType: string);
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command.
+	*
+	* @fires execute
+	* @param options.type The type of the list style, e.g. `'disc'` or `'square'`. If `null` is specified, the default
+	* style will be applied.
+	*/
+	override execute(options?: {
+		type?: string | null;
+	}): void;
+	/**
+	* 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;
+	/**
+	* Checks if the provided list style is valid. Also changes the selection to a list if it's not set yet.
+	*
+	* @param options Additional options.
+	* @param options.type The type of the list style. If `null` is specified, the function does nothing.
+	*/
+	private _tryToConvertItemsToList;
 }

package/dist/legacylistproperties.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/legacylistproperties
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { LegacyListPropertiesEditing } from './legacylistproperties/legacylistpropertiesediting.js';
-import { ListPropertiesUI } from './listproperties/listpropertiesui.js';
+* @module list/legacylistproperties
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { LegacyListPropertiesEditing } from "./legacylistproperties/legacylistpropertiesediting.js";
+import { ListPropertiesUI } from "./listproperties/listpropertiesui.js";
 /**
- * The legacy list properties feature.
- *
- * This is a "glue" plugin that loads the {@link module:list/legacylistproperties/legacylistpropertiesediting~LegacyListPropertiesEditing
- * legacy list properties editing feature} and the
- * {@link module:list/listproperties/listpropertiesui~ListPropertiesUI list properties UI feature}.
- */
+* The legacy list properties feature.
+*
+* This is a "glue" plugin that loads the {@link module:list/legacylistproperties/legacylistpropertiesediting~LegacyListPropertiesEditing
+* legacy list properties editing feature} and the
+* {@link module:list/listproperties/listpropertiesui~ListPropertiesUI list properties UI feature}.
+*/
 export declare class LegacyListProperties extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof LegacyListPropertiesEditing, typeof ListPropertiesUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "LegacyListProperties";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[LegacyListPropertiesEditing, ListPropertiesUI]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "LegacyListProperties";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
 }

package/dist/legacytodolist/legacychecktodolistcommand.d.ts

@@ -1,52 +1,52 @@
 /**
- * @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/legacychecktodolistcommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import type { ModelElement } from '@ckeditor/ckeditor5-engine';
+* @module list/legacytodolist/legacychecktodolistcommand
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
+import type { ModelElement } from "@ckeditor/ckeditor5-engine";
 /**
- * The check to-do command.
- *
- * The command is registered by the {@link module:list/legacytodolist/legacytodolistediting~LegacyTodoListEditing} as
- * the `checkTodoList` editor command and it is also available via aliased `todoListCheck` name.
- */
+* The check to-do command.
+*
+* The command is registered by the {@link module:list/legacytodolist/legacytodolistediting~LegacyTodoListEditing} as
+* the `checkTodoList` editor command and it is also available via aliased `todoListCheck` name.
+*/
 export declare class LegacyCheckTodoListCommand extends Command {
-    /**
-     * A list of to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
-     *
-     * @observable
-     * @readonly
-     */
-    value: boolean;
-    /**
-     * A list of to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
-     *
-     * @internal
-     */
-    _selectedElements: Array<ModelElement>;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
-     */
-    refresh(): void;
-    /**
-     * Gets all to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
-     */
-    private _getSelectedItems;
-    /**
-     * Executes the command.
-     *
-     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply
-     * the attribute. Otherwise, the command will remove the attribute. If not set, the command will look for its current
-     * value to decide what it should do.
-     */
-    execute(options?: {
-        forceValue?: boolean;
-    }): void;
+	/**
+	* A list of to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
+	*
+	* @observable
+	* @readonly
+	*/
+	value: boolean;
+	/**
+	* A list of to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
+	*
+	* @internal
+	*/
+	_selectedElements: Array<ModelElement>;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
+	*/
+	override refresh(): void;
+	/**
+	* Gets all to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
+	*/
+	private _getSelectedItems;
+	/**
+	* Executes the command.
+	*
+	* @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply
+	* the attribute. Otherwise, the command will remove the attribute. If not set, the command will look for its current
+	* value to decide what it should do.
+	*/
+	override execute(options?: {
+		forceValue?: boolean;
+	}): void;
 }

package/dist/legacytodolist/legacytodolistconverters.d.ts

@@ -1,90 +1,90 @@
 /**
- * @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/legacytodolistconverters
- */
-import type { DowncastAttributeEvent, DowncastInsertEvent, ModelElement, MapperModelToViewPositionEvent, Model, UpcastElementEvent, EditingView } from '@ckeditor/ckeditor5-engine';
-import { type GetCallback } from '@ckeditor/ckeditor5-utils';
+* @module list/legacytodolist/legacytodolistconverters
+*/
+import type { DowncastAttributeEvent, DowncastInsertEvent, ModelElement, MapperModelToViewPositionEvent, Model, UpcastElementEvent, EditingView } from "@ckeditor/ckeditor5-engine";
+import { type GetCallback } from "@ckeditor/ckeditor5-utils";
 /**
- * A model-to-view converter for the `listItem` model element insertion.
- *
- * It converts the `listItem` model element to an unordered list with a {@link module:engine/view/uielement~ViewUIElement checkbox element}
- * at the beginning of each list item. It also merges the list with surrounding lists (if available).
- *
- * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
- *
- * @internal
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
- * @param model Model instance.
- * @param onCheckboxChecked Callback function.
- * @returns Returns a conversion callback.
- */
+* A model-to-view converter for the `listItem` model element insertion.
+*
+* It converts the `listItem` model element to an unordered list with a {@link module:engine/view/uielement~ViewUIElement checkbox element}
+* at the beginning of each list item. It also merges the list with surrounding lists (if available).
+*
+* It is used by {@link module:engine/controller/editingcontroller~EditingController}.
+*
+* @internal
+* @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
+* @param model Model instance.
+* @param onCheckboxChecked Callback function.
+* @returns Returns a conversion callback.
+*/
 export declare function modelViewInsertion(model: Model, onCheckboxChecked: (element: ModelElement) => void): GetCallback<DowncastInsertEvent<ModelElement>>;
 /**
- * A model-to-view converter for the `listItem` model element insertion.
- *
- * It is used by {@link module:engine/controller/datacontroller~DataController}.
- *
- * @internal
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
- * @param model Model instance.
- * @returns Returns a conversion callback.
- */
+* A model-to-view converter for the `listItem` model element insertion.
+*
+* It is used by {@link module:engine/controller/datacontroller~DataController}.
+*
+* @internal
+* @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
+* @param model Model instance.
+* @returns Returns a conversion callback.
+*/
 export declare function dataModelViewInsertion(model: Model): GetCallback<DowncastInsertEvent<ModelElement>>;
 /**
- * A view-to-model converter for the checkbox element inside a view list item.
- *
- * It changes the `listType` of the model `listItem` to a `todo` value.
- * When a view checkbox element is marked as checked, an additional `todoListChecked="true"` attribute is added to the model item.
- *
- * It is used by {@link module:engine/controller/datacontroller~DataController}.
- *
- * @internal
- * @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
- */
+* A view-to-model converter for the checkbox element inside a view list item.
+*
+* It changes the `listType` of the model `listItem` to a `todo` value.
+* When a view checkbox element is marked as checked, an additional `todoListChecked="true"` attribute is added to the model item.
+*
+* It is used by {@link module:engine/controller/datacontroller~DataController}.
+*
+* @internal
+* @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
+*/
 export declare const dataViewModelCheckmarkInsertion: GetCallback<UpcastElementEvent>;
 /**
- * A model-to-view converter for the `listType` attribute change on the `listItem` model element.
- *
- * This change means that the `<li>` element parent changes to `<ul class="todo-list">` and a
- * {@link module:engine/view/uielement~ViewUIElement checkbox UI element} is added at the beginning
- * of the list item element (or vice versa).
- *
- * This converter is preceded by {@link module:list/legacylist/legacyconverters~modelViewChangeType} and followed by
- * {@link module:list/legacylist/legacyconverters~modelViewMergeAfterChangeType} to handle splitting and merging surrounding lists
- * of the same type.
- *
- * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
- *
- * @internal
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
- * @param onCheckedChange Callback fired after clicking the checkbox UI element.
- * @param view Editing view controller.
- * @returns Returns a conversion callback.
- */
+* A model-to-view converter for the `listType` attribute change on the `listItem` model element.
+*
+* This change means that the `<li>` element parent changes to `<ul class="todo-list">` and a
+* {@link module:engine/view/uielement~ViewUIElement checkbox UI element} is added at the beginning
+* of the list item element (or vice versa).
+*
+* This converter is preceded by {@link module:list/legacylist/legacyconverters~modelViewChangeType} and followed by
+* {@link module:list/legacylist/legacyconverters~modelViewMergeAfterChangeType} to handle splitting and merging surrounding lists
+* of the same type.
+*
+* It is used by {@link module:engine/controller/editingcontroller~EditingController}.
+*
+* @internal
+* @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
+* @param onCheckedChange Callback fired after clicking the checkbox UI element.
+* @param view Editing view controller.
+* @returns Returns a conversion callback.
+*/
 export declare function modelViewChangeType(onCheckedChange: (element: ModelElement) => void, view: EditingView): GetCallback<DowncastAttributeEvent<ModelElement>>;
 /**
- * A model-to-view converter for the `todoListChecked` attribute change on the `listItem` model element.
- *
- * It marks the {@link module:engine/view/uielement~ViewUIElement checkbox UI element} as checked.
- *
- * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
- *
- * @internal
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
- * @param onCheckedChange Callback fired after clicking the checkbox UI element.
- * @returns Returns a conversion callback.
- */
+* A model-to-view converter for the `todoListChecked` attribute change on the `listItem` model element.
+*
+* It marks the {@link module:engine/view/uielement~ViewUIElement checkbox UI element} as checked.
+*
+* It is used by {@link module:engine/controller/editingcontroller~EditingController}.
+*
+* @internal
+* @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
+* @param onCheckedChange Callback fired after clicking the checkbox UI element.
+* @returns Returns a conversion callback.
+*/
 export declare function modelViewChangeChecked(onCheckedChange: (element: ModelElement) => void): GetCallback<DowncastAttributeEvent<ModelElement>>;
 /**
- * A model-to-view position at zero offset mapper.
- *
- * This helper ensures that position inside todo-list in the view is mapped after the checkbox.
- *
- * It only handles the position at the beginning of a list item as other positions are properly mapped be the default mapper.
- *
- * @internal
- */
+* A model-to-view position at zero offset mapper.
+*
+* This helper ensures that position inside todo-list in the view is mapped after the checkbox.
+*
+* It only handles the position at the beginning of a list item as other positions are properly mapped be the default mapper.
+*
+* @internal
+*/
 export declare function mapModelToViewPosition(view: EditingView): GetCallback<MapperModelToViewPositionEvent>;

package/dist/legacytodolist/legacytodolistediting.d.ts

@@ -1,50 +1,50 @@
 /**
- * @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';
-import { LegacyListEditing } from '../legacylist/legacylistediting.js';
+* @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, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+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.
- */
+* 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 declare class LegacyTodoListEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "LegacyTodoListEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @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;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "LegacyTodoListEditing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[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;
 }