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

package/dist/listconfig.d.ts

@@ -1,246 +1,246 @@
 /**
- * @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/listconfig
- */
-import { type ArrayOrItem } from '@ckeditor/ckeditor5-utils';
+* @module list/listconfig
+*/
+import { type ArrayOrItem } from "@ckeditor/ckeditor5-utils";
 /**
- * The configuration of the {@link module:list/list~List list} feature
- * and the {@link module:list/legacylist~LegacyList legacy list} feature.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		list:  ... // The list feature configuration.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- *
- * @interface ListConfig
- */
+* The configuration of the {@link module:list/list~List list} feature
+* and the {@link module:list/legacylist~LegacyList legacy list} feature.
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		list:  ... // The list feature configuration.
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*
+* @interface ListConfig
+*/
 export interface ListConfig {
-    /**
-     * The configuration of the {@link module:list/listproperties~ListProperties} feature and the
-     * {@link module:list/legacylistproperties~LegacyListProperties legacy list properties} feature.
-     *
-     * Read more in {@link module:list/listconfig~ListPropertiesConfig}.
-     */
-    properties?: ListPropertiesConfig;
-    /**
-     * Allows multiple blocks in single list item.
-     *
-     * With this option enabled you can have block widgets, for example images or even tables, within a list item.
-     *
-     * **Note:** This is enabled by default.
-     *
-     * @default true
-     */
-    multiBlock?: boolean;
-    /**
-     * Enables list item marker formatting. Current list of integrated formatting plugins includes:
-     * * {@link module:list/listformatting/listitemfontfamilyintegration~ListItemFontFamilyIntegration Font family}
-     * * {@link module:list/listformatting/listitemfontsizeintegration~ListItemFontSizeIntegration Font size}
-     * * {@link module:list/listformatting/listitemfontcolorintegration~ListItemFontColorIntegration Font color}
-     * * {@link module:list/listformatting/listitemboldintegration~ListItemBoldIntegration Bold}
-     * * {@link module:list/listformatting/listitemitalicintegration~ListItemItalicIntegration Italic}
-     *
-     * **Note:** This is enabled by default.
-     *
-     * @default true
-     */
-    enableListItemMarkerFormatting?: boolean;
-    /**
-     * When set to `true`, list items can be indented by more than one level relative to their parent.
-     * By default, the editor enforces that each nested list item is only one level deeper than its parent.
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( editorElement, {
-     * 		list: {
-     * 			enableSkipLevelLists: true
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     *
-     * @default false
-     */
-    enableSkipLevelLists?: boolean;
+	/**
+	* The configuration of the {@link module:list/listproperties~ListProperties} feature and the
+	* {@link module:list/legacylistproperties~LegacyListProperties legacy list properties} feature.
+	*
+	* Read more in {@link module:list/listconfig~ListPropertiesConfig}.
+	*/
+	properties?: ListPropertiesConfig;
+	/**
+	* Allows multiple blocks in single list item.
+	*
+	* With this option enabled you can have block widgets, for example images or even tables, within a list item.
+	*
+	* **Note:** This is enabled by default.
+	*
+	* @default true
+	*/
+	multiBlock?: boolean;
+	/**
+	* Enables list item marker formatting. Current list of integrated formatting plugins includes:
+	* * {@link module:list/listformatting/listitemfontfamilyintegration~ListItemFontFamilyIntegration Font family}
+	* * {@link module:list/listformatting/listitemfontsizeintegration~ListItemFontSizeIntegration Font size}
+	* * {@link module:list/listformatting/listitemfontcolorintegration~ListItemFontColorIntegration Font color}
+	* * {@link module:list/listformatting/listitemboldintegration~ListItemBoldIntegration Bold}
+	* * {@link module:list/listformatting/listitemitalicintegration~ListItemItalicIntegration Italic}
+	*
+	* **Note:** This is enabled by default.
+	*
+	* @default true
+	*/
+	enableListItemMarkerFormatting?: boolean;
+	/**
+	* When set to `true`, list items can be indented by more than one level relative to their parent.
+	* By default, the editor enforces that each nested list item is only one level deeper than its parent.
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( editorElement, {
+	* 		list: {
+	* 			enableSkipLevelLists: true
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*
+	* @default false
+	*/
+	enableSkipLevelLists?: boolean;
 }
 /**
- * The configuration of the {@link module:list/listproperties~ListProperties list properties} feature and the
- * {@link module:list/legacylistproperties~LegacyListProperties legacy list properties} feature.
- *
- * This configuration controls the individual list properties. For instance, it enables or disables specific editor commands
- * operating on lists ({@link module:list/listproperties/liststylecommand~ListStyleCommand `'listStyle'`},
- * {@link module:list/listproperties/liststartcommand~ListStartCommand `'listStart'`},
- * {@link module:list/listproperties/listreversedcommand~ListReversedCommand `'listReversed'`}, or on the legacy lists
- * {@link module:list/legacylistproperties/legacyliststylecommand~LegacyListStyleCommand `'listStyle'`},
- * {@link module:list/legacylistproperties/legacyliststartcommand~LegacyListStartCommand `'listStart'`},
- * {@link module:list/legacylistproperties/legacylistreversedcommand~LegacyListReversedCommand `'listReversed'`}), the look of the UI
- * (`'numberedList'` and `'bulletedList'` dropdowns), and the editor data pipeline (allowed HTML attributes).
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		list: {
- * 			properties: {
- * 				styles: true,
- * 				startIndex: true,
- * 				reversed: true
- * 			}
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- */
+* The configuration of the {@link module:list/listproperties~ListProperties list properties} feature and the
+* {@link module:list/legacylistproperties~LegacyListProperties legacy list properties} feature.
+*
+* This configuration controls the individual list properties. For instance, it enables or disables specific editor commands
+* operating on lists ({@link module:list/listproperties/liststylecommand~ListStyleCommand `'listStyle'`},
+* {@link module:list/listproperties/liststartcommand~ListStartCommand `'listStart'`},
+* {@link module:list/listproperties/listreversedcommand~ListReversedCommand `'listReversed'`}, or on the legacy lists
+* {@link module:list/legacylistproperties/legacyliststylecommand~LegacyListStyleCommand `'listStyle'`},
+* {@link module:list/legacylistproperties/legacyliststartcommand~LegacyListStartCommand `'listStart'`},
+* {@link module:list/legacylistproperties/legacylistreversedcommand~LegacyListReversedCommand `'listReversed'`}), the look of the UI
+* (`'numberedList'` and `'bulletedList'` dropdowns), and the editor data pipeline (allowed HTML attributes).
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		list: {
+* 			properties: {
+* 				styles: true,
+* 				startIndex: true,
+* 				reversed: true
+* 			}
+* 		}
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+*/
 export interface ListPropertiesConfig {
-    /**
-     * When set, the list style feature will be enabled.
-     * It allows changing the `list-style-type` style or the `type` HTML attribute of a list.
-     *
-     * **Note**: Styling using the `type` HTML attribute is only available in
-     * {@link module:list/listproperties~ListProperties list properties}
-     * ({@link module:list/listconfig~ListPropertiesStyleConfig learn more}).
-     *
-     * @default true
-     */
-    styles?: boolean | ListPropertiesStyleConfig | ArrayOrItem<ListPropertiesStyleListType>;
-    /**
-     * When set, the list start index feature will be enabled. It allows changing the `start` HTML attribute of the numbered lists. As a
-     * result, it will be possible to specify the start value of the first item in an ordered list.
-     *
-     * **Note**: This configuration does not affect bulleted and to-do lists.
-     *
-     * @default false
-     */
-    startIndex?: boolean;
-    /**
-     * When set, the reversed list feature will be enabled. It allows changing the `reversed` HTML attribute of the numbered lists. As a
-     * result, it will be possible to make the list order descending instead of ascending.
-     *
-     * **Note**: This configuration does not affect bulleted and to-do lists.
-     *
-     * @default false
-     */
-    reversed?: boolean;
+	/**
+	* When set, the list style feature will be enabled.
+	* It allows changing the `list-style-type` style or the `type` HTML attribute of a list.
+	*
+	* **Note**: Styling using the `type` HTML attribute is only available in
+	* {@link module:list/listproperties~ListProperties list properties}
+	* ({@link module:list/listconfig~ListPropertiesStyleConfig learn more}).
+	*
+	* @default true
+	*/
+	styles?: boolean | ListPropertiesStyleConfig | ArrayOrItem<ListPropertiesStyleListType>;
+	/**
+	* When set, the list start index feature will be enabled. It allows changing the `start` HTML attribute of the numbered lists. As a
+	* result, it will be possible to specify the start value of the first item in an ordered list.
+	*
+	* **Note**: This configuration does not affect bulleted and to-do lists.
+	*
+	* @default false
+	*/
+	startIndex?: boolean;
+	/**
+	* When set, the reversed list feature will be enabled. It allows changing the `reversed` HTML attribute of the numbered lists. As a
+	* result, it will be possible to make the list order descending instead of ascending.
+	*
+	* **Note**: This configuration does not affect bulleted and to-do lists.
+	*
+	* @default false
+	*/
+	reversed?: boolean;
 }
 export interface ListPropertiesStyleConfig {
-    /**
-     * Enable style feature for the given list type only.
-     *
-     * ```ts
-     * {
-     * 	list: {
-     * 		properties: {
-     * 			styles: {
-     * 				listTypes: 'numbered'
-     * 			}
-     *
-     * 			// ...
-     * 		}
-     * 	},
-     *
-     * 	// ...
-     * }
-     * ```
-     *
-     *
-     * **Note**: This configuration works only with
-     * {@link module:list/listproperties~ListProperties list properties}.
-     *
-     * @default ['bulleted','numbered']
-     */
-    listTypes?: ArrayOrItem<ListPropertiesStyleListType>;
-    /**
-     * When set `true`, the list style feature will use the `type` attribute of `<ul>` and `<ol>` elements instead of the `list-style-type`
-     * style.
-     *
-     * ```ts
-     * {
-     * 	list: {
-     * 		properties: {
-     * 			styles: {
-     * 				useAttribute: true
-     * 			},
-     *
-     * 			// ...
-     * 		}
-     * 	},
-     *
-     * 	// ...
-     * }
-     * ```
-     *
-     * **Note**: Due to limitations of HTML, the "Decimal with leading zero" style is impossible to set using the `type` attribute.
-     *
-     * **Note**: This configuration works only with
-     * {@link module:list/listproperties~ListProperties list properties}.
-     *
-     * @default false
-     */
-    useAttribute?: boolean;
-    /**
-     * Defines which list styles should be available in the UI.
-     * Accepts a configuration object with numbered and bulleted styles.
-     *
-     * ```ts
-     * {
-     *   list: {
-     *     properties: {
-     *       styles: {
-     *         listStyleTypes: {
-     *           numbered: [ 'decimal', 'lower-roman', 'upper-roman' ],
-     *           bulleted: [ 'disc', 'circle' ]
-     *         }
-     *       }
-     *     }
-     *   }
-     * }
-     * ```
-     *
-     * When the `listTypes` configuration is set, `listStyleTypes` will only take effect for the enabled list types.
-     * For example, with the following configuration:
-     *
-     * ```ts
-     * {
-     *   list: {
-     *     properties: {
-     *       styles: {
-     *         listTypes: 'numbered',
-     *         listStyleTypes: {
-     *           numbered: [ 'decimal', 'lower-roman' ],
-     *           bulleted: [ 'disc', 'circle' ]
-     *         }
-     *       }
-     *     }
-     *   }
-     * }
-     * ```
-     *
-     * Only the numbered list styles will be available in the UI, as the `listTypes` property limits style selection to numbered lists only.
-     *
-     * **Note**: This configuration works only with
-     * {@link module:list/listproperties~ListProperties list properties}.
-     *
-     * @default `{
-     *   numbered: [ 'decimal', 'decimal-leading-zero', 'lower-roman', 'upper-roman', 'lower-latin', 'upper-latin' ],
-     *   bulleted: [ 'disc', 'circle', 'square' ]
-     * }`
-     */
-    listStyleTypes?: ListStyleTypesConfig;
+	/**
+	* Enable style feature for the given list type only.
+	*
+	* ```ts
+	* {
+	* 	list: {
+	* 		properties: {
+	* 			styles: {
+	* 				listTypes: 'numbered'
+	* 			}
+	*
+	* 			// ...
+	* 		}
+	* 	},
+	*
+	* 	// ...
+	* }
+	* ```
+	*
+	*
+	* **Note**: This configuration works only with
+	* {@link module:list/listproperties~ListProperties list properties}.
+	*
+	* @default ['bulleted','numbered']
+	*/
+	listTypes?: ArrayOrItem<ListPropertiesStyleListType>;
+	/**
+	* When set `true`, the list style feature will use the `type` attribute of `<ul>` and `<ol>` elements instead of the `list-style-type`
+	* style.
+	*
+	* ```ts
+	* {
+	* 	list: {
+	* 		properties: {
+	* 			styles: {
+	* 				useAttribute: true
+	* 			},
+	*
+	* 			// ...
+	* 		}
+	* 	},
+	*
+	* 	// ...
+	* }
+	* ```
+	*
+	* **Note**: Due to limitations of HTML, the "Decimal with leading zero" style is impossible to set using the `type` attribute.
+	*
+	* **Note**: This configuration works only with
+	* {@link module:list/listproperties~ListProperties list properties}.
+	*
+	* @default false
+	*/
+	useAttribute?: boolean;
+	/**
+	* Defines which list styles should be available in the UI.
+	* Accepts a configuration object with numbered and bulleted styles.
+	*
+	* ```ts
+	* {
+	*   list: {
+	*     properties: {
+	*       styles: {
+	*         listStyleTypes: {
+	*           numbered: [ 'decimal', 'lower-roman', 'upper-roman' ],
+	*           bulleted: [ 'disc', 'circle' ]
+	*         }
+	*       }
+	*     }
+	*   }
+	* }
+	* ```
+	*
+	* When the `listTypes` configuration is set, `listStyleTypes` will only take effect for the enabled list types.
+	* For example, with the following configuration:
+	*
+	* ```ts
+	* {
+	*   list: {
+	*     properties: {
+	*       styles: {
+	*         listTypes: 'numbered',
+	*         listStyleTypes: {
+	*           numbered: [ 'decimal', 'lower-roman' ],
+	*           bulleted: [ 'disc', 'circle' ]
+	*         }
+	*       }
+	*     }
+	*   }
+	* }
+	* ```
+	*
+	* Only the numbered list styles will be available in the UI, as the `listTypes` property limits style selection to numbered lists only.
+	*
+	* **Note**: This configuration works only with
+	* {@link module:list/listproperties~ListProperties list properties}.
+	*
+	* @default `{
+	*   numbered: [ 'decimal', 'decimal-leading-zero', 'lower-roman', 'upper-roman', 'lower-latin', 'upper-latin' ],
+	*   bulleted: [ 'disc', 'circle', 'square' ]
+	* }`
+	*/
+	listStyleTypes?: ListStyleTypesConfig;
 }
 export interface ListStyleTypesConfig {
-    numbered?: Array<NumberedListStyleType>;
-    bulleted?: Array<BulletedListStyleType>;
+	numbered?: Array<NumberedListStyleType>;
+	bulleted?: Array<BulletedListStyleType>;
 }
-export type ListPropertiesStyleListType = 'numbered' | 'bulleted';
-export type NumberedListStyleType = 'decimal' | 'decimal-leading-zero' | 'lower-roman' | 'upper-roman' | 'lower-latin' | 'upper-latin' | 'arabic-indic';
-export type BulletedListStyleType = 'disc' | 'circle' | 'square';
+export type ListPropertiesStyleListType = "numbered" | "bulleted";
+export type NumberedListStyleType = "decimal" | "decimal-leading-zero" | "lower-roman" | "upper-roman" | "lower-latin" | "upper-latin" | "arabic-indic";
+export type BulletedListStyleType = "disc" | "circle" | "square";

package/dist/listformatting/listitemboldintegration.d.ts

@@ -1,34 +1,34 @@
 /**
- * @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/listformatting/listitemboldintegration
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { ListEditing } from '../list/listediting.js';
+* @module list/listformatting/listitemboldintegration
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ListEditing } from "../list/listediting.js";
 /**
- * The list item bold integration plugin.
- */
+* The list item bold integration plugin.
+*/
 export declare class ListItemBoldIntegration extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListItemBoldIntegration";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ListEditing];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ListItemBoldIntegration";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ListEditing]>;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
 }

package/dist/listformatting/listitemfontcolorintegration.d.ts

@@ -1,34 +1,34 @@
 /**
- * @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/listformatting/listitemfontcolorintegration
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { ListEditing } from '../list/listediting.js';
+* @module list/listformatting/listitemfontcolorintegration
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ListEditing } from "../list/listediting.js";
 /**
- * The list item font color integration plugin.
- */
+* The list item font color integration plugin.
+*/
 export declare class ListItemFontColorIntegration extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListItemFontColorIntegration";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ListEditing];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ListItemFontColorIntegration";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ListEditing]>;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
 }