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

package/dist/listproperties/ui/listpropertiesview.d.ts

@@ -1,161 +1,161 @@
 /**
- * @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/listproperties/ui/listpropertiesview
- */
-import { ButtonView, View, ViewCollection, FocusCycler, SwitchButtonView, LabeledFieldView, CollapsibleView, type InputNumberView, type FocusableView } from '@ckeditor/ckeditor5-ui';
-import { FocusTracker, KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
-import type { NormalizedListPropertiesConfig } from '../utils/config.js';
-import '../../../theme/listproperties.css';
+* @module list/listproperties/ui/listpropertiesview
+*/
+import { ButtonView, View, ViewCollection, FocusCycler, SwitchButtonView, LabeledFieldView, CollapsibleView, type InputNumberView, type FocusableView } from "@ckeditor/ckeditor5-ui";
+import { FocusTracker, KeystrokeHandler, type Locale } from "@ckeditor/ckeditor5-utils";
+import type { NormalizedListPropertiesConfig } from "../utils/config.js";
+import "../../../theme/listproperties.css";
 /**
- * The list properties view to be displayed in the list dropdown.
- *
- * Contains a grid of available list styles and, for numbered list, also the list start index and reversed fields.
- *
- * @internal
- */
+* The list properties view to be displayed in the list dropdown.
+*
+* Contains a grid of available list styles and, for numbered list, also the list start index and reversed fields.
+*
+* @internal
+*/
 export declare class ListPropertiesView extends View {
-    /**
-     * @inheritDoc
-     */
-    locale: Locale;
-    /**
-     * A collection of the child views.
-     */
-    readonly children: ViewCollection;
-    /**
-     * A view that renders the grid of list styles.
-     */
-    readonly stylesView: StylesView | null;
-    /**
-     * A collapsible view that hosts additional list property fields ({@link #startIndexFieldView} and
-     * {@link #reversedSwitchButtonView}) to visually separate them from the {@link #stylesView grid of styles}.
-     *
-     * **Note**: Only present when:
-     * * the view represents **numbered** list properties,
-     * * and the {@link #stylesView} is rendered,
-     * * and either {@link #startIndexFieldView} or {@link #reversedSwitchButtonView} is rendered.
-     *
-     * @readonly
-     */
-    additionalPropertiesCollapsibleView: CollapsibleView | null;
-    /**
-     * A labeled number field allowing the user to set the start index of the list.
-     *
-     * **Note**: Only present when the view represents **numbered** list properties.
-     *
-     * @readonly
-     */
-    startIndexFieldView: LabeledFieldView<InputNumberView> | null;
-    /**
-     * A switch button allowing the user to make the edited list reversed.
-     *
-     * **Note**: Only present when the view represents **numbered** list properties.
-     *
-     * @readonly
-     */
-    reversedSwitchButtonView: SwitchButtonView | null;
-    /**
-     * Tracks information about the DOM focus in the view.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * A collection of views that can be focused in the properties view.
-     */
-    readonly focusables: ViewCollection<FocusableView>;
-    /**
-     * Helps cycling over {@link #focusables} in the view.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * Creates an instance of the list properties view.
-     *
-     * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
-     * @param options Options of the view.
-     * @param options.enabledProperties An object containing the configuration of enabled list property names.
-     * Allows conditional rendering the sub-components of the properties view.
-     * @param options.styleButtonViews A list of style buttons to be rendered
-     * inside the styles grid. The grid will not be rendered when `enabledProperties` does not include the `'styles'` key.
-     * @param options.styleGridAriaLabel An assistive technologies label set on the grid of styles (if the grid is rendered).
-     */
-    constructor(locale: Locale, { enabledProperties, styleButtonViews, styleGridAriaLabel }: {
-        enabledProperties: NormalizedListPropertiesConfig;
-        styleButtonViews: Array<ButtonView> | null;
-        styleGridAriaLabel: string;
-    });
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-    /**
-     * @inheritDoc
-     */
-    focusLast(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Creates the list styles grid.
-     *
-     * @param styleButtons Buttons to be placed in the grid.
-     * @param styleGridAriaLabel The assistive technology label of the grid.
-     */
-    private _createStylesView;
-    /**
-     * Renders {@link #startIndexFieldView} and/or {@link #reversedSwitchButtonView} depending on the configuration of the properties view.
-     *
-     * @param enabledProperties An object containing the configuration of enabled list property names
-     * (see {@link #constructor}).
-     */
-    private _addNumberedListPropertyViews;
-    /**
-     * Creates the list start index labeled field.
-     */
-    private _createStartIndexField;
-    /**
-     * Creates the reversed list switch button.
-     */
-    private _createReversedSwitchButton;
+	/**
+	* @inheritDoc
+	*/
+	locale: Locale;
+	/**
+	* A collection of the child views.
+	*/
+	readonly children: ViewCollection;
+	/**
+	* A view that renders the grid of list styles.
+	*/
+	readonly stylesView: StylesView | null;
+	/**
+	* A collapsible view that hosts additional list property fields ({@link #startIndexFieldView} and
+	* {@link #reversedSwitchButtonView}) to visually separate them from the {@link #stylesView grid of styles}.
+	*
+	* **Note**: Only present when:
+	* * the view represents **numbered** list properties,
+	* * and the {@link #stylesView} is rendered,
+	* * and either {@link #startIndexFieldView} or {@link #reversedSwitchButtonView} is rendered.
+	*
+	* @readonly
+	*/
+	additionalPropertiesCollapsibleView: CollapsibleView | null;
+	/**
+	* A labeled number field allowing the user to set the start index of the list.
+	*
+	* **Note**: Only present when the view represents **numbered** list properties.
+	*
+	* @readonly
+	*/
+	startIndexFieldView: LabeledFieldView<InputNumberView> | null;
+	/**
+	* A switch button allowing the user to make the edited list reversed.
+	*
+	* **Note**: Only present when the view represents **numbered** list properties.
+	*
+	* @readonly
+	*/
+	reversedSwitchButtonView: SwitchButtonView | null;
+	/**
+	* Tracks information about the DOM focus in the view.
+	*/
+	readonly focusTracker: FocusTracker;
+	/**
+	* An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+	*/
+	readonly keystrokes: KeystrokeHandler;
+	/**
+	* A collection of views that can be focused in the properties view.
+	*/
+	readonly focusables: ViewCollection<FocusableView>;
+	/**
+	* Helps cycling over {@link #focusables} in the view.
+	*/
+	readonly focusCycler: FocusCycler;
+	/**
+	* Creates an instance of the list properties view.
+	*
+	* @param locale The {@link module:core/editor/editor~Editor#locale} instance.
+	* @param options Options of the view.
+	* @param options.enabledProperties An object containing the configuration of enabled list property names.
+	* Allows conditional rendering the sub-components of the properties view.
+	* @param options.styleButtonViews A list of style buttons to be rendered
+	* inside the styles grid. The grid will not be rendered when `enabledProperties` does not include the `'styles'` key.
+	* @param options.styleGridAriaLabel An assistive technologies label set on the grid of styles (if the grid is rendered).
+	*/
+	constructor(locale: Locale, { enabledProperties, styleButtonViews, styleGridAriaLabel }: {
+		enabledProperties: NormalizedListPropertiesConfig;
+		styleButtonViews: Array<ButtonView> | null;
+		styleGridAriaLabel: string;
+	});
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	focus(): void;
+	/**
+	* @inheritDoc
+	*/
+	focusLast(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Creates the list styles grid.
+	*
+	* @param styleButtons Buttons to be placed in the grid.
+	* @param styleGridAriaLabel The assistive technology label of the grid.
+	*/
+	private _createStylesView;
+	/**
+	* Renders {@link #startIndexFieldView} and/or {@link #reversedSwitchButtonView} depending on the configuration of the properties view.
+	*
+	* @param enabledProperties An object containing the configuration of enabled list property names
+	* (see {@link #constructor}).
+	*/
+	private _addNumberedListPropertyViews;
+	/**
+	* Creates the list start index labeled field.
+	*/
+	private _createStartIndexField;
+	/**
+	* Creates the reversed list switch button.
+	*/
+	private _createReversedSwitchButton;
 }
 /**
- * The view that renders the grid of styles.
- *
- * @internal
- */
+* The view that renders the grid of styles.
+*
+* @internal
+*/
 export type StylesView = View & {
-    children: ViewCollection;
-    focusTracker: FocusTracker;
-    keystrokes: KeystrokeHandler;
-    focus(): void;
+	children: ViewCollection;
+	focusTracker: FocusTracker;
+	keystrokes: KeystrokeHandler;
+	focus(): void;
 };
 /**
- * Fired when the list start index value has changed via {@link ~ListPropertiesView#startIndexFieldView}.
- *
- * @eventName ~ListPropertiesView#listStart
- */
+* Fired when the list start index value has changed via {@link ~ListPropertiesView#startIndexFieldView}.
+*
+* @eventName ~ListPropertiesView#listStart
+*/
 export type ListPropertiesViewListStartEvent = {
-    name: 'listStart';
-    args: [data: {
-        startIndex: number;
-    }];
+	name: "listStart";
+	args: [data: {
+		startIndex: number;
+	}];
 };
 /**
- * Fired when the list order has changed (reversed) via {@link ~ListPropertiesView#reversedSwitchButtonView}.
- *
- * @eventName ~ListPropertiesView#listReversed
- */
+* Fired when the list order has changed (reversed) via {@link ~ListPropertiesView#reversedSwitchButtonView}.
+*
+* @eventName ~ListPropertiesView#listReversed
+*/
 export type ListPropertiesViewListReversedEvent = {
-    name: 'listReversed';
-    args: [];
+	name: "listReversed";
+	args: [];
 };

package/dist/listproperties/utils/config.d.ts

@@ -1,27 +1,27 @@
 /**
- * @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 type { ListPropertiesConfig, ListPropertiesStyleListType } from '../../listconfig.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 type { ListPropertiesConfig, ListPropertiesStyleListType } from "../../listconfig.js";
 /**
- * Normalizes {@link module:list/listconfig~ListPropertiesConfig} in the configuration of the list properties feature.
- * The structure of normalized list properties options looks as follows:
- *
- * ```ts
- * {
- * 	styles: {
- * 		listTypes: [ 'bulleted', 'numbered' ],
- * 		useAttribute: false
- * 	},
- * 	startIndex: true,
- * 	reversed: true
- * }
- * ```
- *
- * @internal
- * @param config The list properties {@link module:list/listconfig~ListPropertiesConfig config}.
- * @returns An object with normalized list properties options.
- */
+* Normalizes {@link module:list/listconfig~ListPropertiesConfig} in the configuration of the list properties feature.
+* The structure of normalized list properties options looks as follows:
+*
+* ```ts
+* {
+* 	styles: {
+* 		listTypes: [ 'bulleted', 'numbered' ],
+* 		useAttribute: false
+* 	},
+* 	startIndex: true,
+* 	reversed: true
+* }
+* ```
+*
+* @internal
+* @param config The list properties {@link module:list/listconfig~ListPropertiesConfig config}.
+* @returns An object with normalized list properties options.
+*/
 export declare function getNormalizedConfig(config: ListPropertiesConfig): NormalizedListPropertiesConfig;
 /**
 * Normalized list properties config.
@@ -29,14 +29,14 @@ export declare function getNormalizedConfig(config: ListPropertiesConfig): Norma
 * @internal
 */
 export type NormalizedListPropertiesConfig = {
-    styles: {
-        listTypes: Array<ListPropertiesStyleListType>;
-        listStyleTypes?: {
-            numbered?: Array<string>;
-            bulleted?: Array<string>;
-        };
-        useAttribute: boolean;
-    };
-    startIndex: boolean;
-    reversed: boolean;
+	styles: {
+		listTypes: Array<ListPropertiesStyleListType>;
+		listStyleTypes?: {
+			numbered?: Array<string>;
+			bulleted?: Array<string>;
+		};
+		useAttribute: boolean;
+	};
+	startIndex: boolean;
+	reversed: boolean;
 };

package/dist/listproperties/utils/style.d.ts

@@ -1,41 +1,41 @@
 /**
- * @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
+*/
 /**
- * Gets all the style types supported by given list type.
- *
- * @internal
- */
+* Gets all the style types supported by given list type.
+*
+* @internal
+*/
 export declare function getAllSupportedStyleTypes(): Array<string>;
 /**
- * Checks whether the given list-style-type is supported by numbered or bulleted list.
- *
- * @internal
- */
-export declare function getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;
+* Checks whether the given list-style-type is supported by numbered or bulleted list.
+*
+* @internal
+*/
+export declare function getListTypeFromListStyleType(listStyleType: string): "bulleted" | "numbered" | null;
 /**
- * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
- *
- * @internal
- */
+* Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
+*
+* @internal
+*/
 export declare function getListStyleTypeFromTypeAttribute(value: string): string | null;
 /**
- * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
- *
- * @internal
- */
+* Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
+*
+* @internal
+*/
 export declare function getTypeAttributeFromListStyleType(value: string): string | null;
 /**
- * Normalizes list style by converting aliases to their canonical form.
- *
- * @internal
- * @param listStyle The list style value to normalize.
- * @returns The canonical form of the list style.
- *
- * @example
- * normalizeListStyle( 'lower-alpha' ); // Returns 'lower-latin'
- * normalizeListStyle( 'upper-alpha' ); // Returns 'upper-latin'
- * normalizeListStyle( 'disc' ); // Returns 'disc'
- */
+* Normalizes list style by converting aliases to their canonical form.
+*
+* @internal
+* @param listStyle The list style value to normalize.
+* @returns The canonical form of the list style.
+*
+* @example
+* normalizeListStyle( 'lower-alpha' ); // Returns 'lower-latin'
+* normalizeListStyle( 'upper-alpha' ); // Returns 'upper-latin'
+* normalizeListStyle( 'disc' ); // Returns 'disc'
+*/
 export declare function normalizeListStyle(listStyle: string): string;

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

package/dist/todolist/checktodolistcommand.d.ts

@@ -1,49 +1,49 @@
 /**
- * @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/todolist/checktodolistcommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+* @module list/todolist/checktodolistcommand
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
 /**
- * The check to-do command.
- *
- * The command is registered by the {@link module:list/todolist/todolistediting~TodoListEditing} as
- * the `checkTodoList` editor command.
- */
+* The check to-do command.
+*
+* The command is registered by the {@link module:list/todolist/todolistediting~TodoListEditing} as
+* the `checkTodoList` editor command.
+*/
 export declare class CheckTodoListCommand extends Command {
-    /**
-     * A list of to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
-     *
-     * @observable
-     * @readonly
-     */
-    value: boolean;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
-     */
-    refresh(): void;
-    /**
-     * 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;
-    /**
-     * Returns a value for the command.
-     */
-    private _getValue;
-    /**
-     * Gets all to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
-     */
-    private _getSelectedItems;
+	/**
+	* A list of to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
+	*
+	* @observable
+	* @readonly
+	*/
+	value: boolean;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
+	*/
+	override refresh(): void;
+	/**
+	* 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;
+	/**
+	* Returns a value for the command.
+	*/
+	private _getValue;
+	/**
+	* Gets all to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
+	*/
+	private _getSelectedItems;
 }