@ckeditor/ckeditor5-list 40.0.0 → 40.1.0

package/src/list.d.ts

@@ -1,26 +1,26 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/list
- */
-import ListEditing from './list/listediting';
-import ListUI from './list/listui';
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * The list feature.
- *
- * This is a "glue" plugin that loads the {@link module:list/list/listediting~ListEditing list editing feature}
- * and {@link module:list/list/listui~ListUI list UI feature}.
- */
-export default class List extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ListEditing, typeof ListUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "List";
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/list
+ */
+import ListEditing from './list/listediting';
+import ListUI from './list/listui';
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The list feature.
+ *
+ * This is a "glue" plugin that loads the {@link module:list/list/listediting~ListEditing list editing feature}
+ * and {@link module:list/list/listui~ListUI list UI feature}.
+ */
+export default class List extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ListEditing, typeof ListUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "List";
+}

package/src/list.js

@@ -1,30 +1,30 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/list
- */
-import ListEditing from './list/listediting';
-import ListUI from './list/listui';
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * The list feature.
- *
- * This is a "glue" plugin that loads the {@link module:list/list/listediting~ListEditing list editing feature}
- * and {@link module:list/list/listui~ListUI list UI feature}.
- */
-export default class List extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [ListEditing, ListUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'List';
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/list
+ */
+import ListEditing from './list/listediting';
+import ListUI from './list/listui';
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The list feature.
+ *
+ * This is a "glue" plugin that loads the {@link module:list/list/listediting~ListEditing list editing feature}
+ * and {@link module:list/list/listui~ListUI list UI feature}.
+ */
+export default class List extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ListEditing, ListUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'List';
+    }
+}

package/src/listconfig.d.ts

@@ -1,132 +1,132 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/listconfig
- */
-/**
- * The configuration of the {@link module:list/list~List list} feature
- * and the {@link module:list/documentlist~DocumentList document list} feature.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		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/documentlistproperties~DocumentListProperties document 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;
-}
-/**
- * The configuration of the {@link module:list/listproperties~ListProperties list properties} feature and the
- * {@link module:list/documentlistproperties~DocumentListProperties document 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 document lists
- * {@link module:list/documentlistproperties/documentliststylecommand~DocumentListStyleCommand `'listStyle'`},
- * {@link module:list/documentlistproperties/documentliststartcommand~DocumentListStartCommand `'listStart'`},
- * {@link module:list/documentlistproperties/documentlistreversedcommand~DocumentListReversedCommand `'listReversed'`}), the look of the UI
- * (`'numberedList'` and `'bulletedList'` dropdowns), and the editor data pipeline (allowed HTML attributes).
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		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/documentlistproperties~DocumentListProperties document list properties}
-     * ({@link module:list/listconfig~ListPropertiesStyleConfig learn more}).
-     *
-     * @default true
-     */
-    styles?: boolean | ListPropertiesStyleConfig;
-    /**
-     * 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 {
-    /**
-     * 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/documentlistproperties~DocumentListProperties document list properties}.
-     *
-     * @default false
-     */
-    useAttribute?: boolean;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/listconfig
+ */
+/**
+ * The configuration of the {@link module:list/list~List list} feature
+ * and the {@link module:list/documentlist~DocumentList document list} feature.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		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/documentlistproperties~DocumentListProperties document 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;
+}
+/**
+ * The configuration of the {@link module:list/listproperties~ListProperties list properties} feature and the
+ * {@link module:list/documentlistproperties~DocumentListProperties document 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 document lists
+ * {@link module:list/documentlistproperties/documentliststylecommand~DocumentListStyleCommand `'listStyle'`},
+ * {@link module:list/documentlistproperties/documentliststartcommand~DocumentListStartCommand `'listStart'`},
+ * {@link module:list/documentlistproperties/documentlistreversedcommand~DocumentListReversedCommand `'listReversed'`}), the look of the UI
+ * (`'numberedList'` and `'bulletedList'` dropdowns), and the editor data pipeline (allowed HTML attributes).
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		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/documentlistproperties~DocumentListProperties document list properties}
+     * ({@link module:list/listconfig~ListPropertiesStyleConfig learn more}).
+     *
+     * @default true
+     */
+    styles?: boolean | ListPropertiesStyleConfig;
+    /**
+     * 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 {
+    /**
+     * 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/documentlistproperties~DocumentListProperties document list properties}.
+     *
+     * @default false
+     */
+    useAttribute?: boolean;
+}

package/src/listconfig.js

@@ -1,5 +1,5 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-export {};
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};

package/src/listproperties/listpropertiesediting.d.ts

@@ -1,72 +1,72 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/listproperties/listpropertiesediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-import ListEditing from '../list/listediting';
-/**
- * The engine of the list properties feature.
- *
- * It sets the value for the `listItem` attribute of the {@link module:list/list~List `<listItem>`} element that
- * allows modifying the list style type.
- *
- * It registers the `'listStyle'`, `'listReversed'` and `'listStart'` commands if they are enabled in the configuration.
- * Read more in {@link module:list/listconfig~ListPropertiesConfig}.
- */
-export default class ListPropertiesEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ListEditing];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListPropertiesEditing";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Starts listening to {@link module:engine/model/model~Model#deleteContent} and checks whether two lists will be merged into a single
-     * one after deleting the content.
-     *
-     * The purpose of this action is to adjust the `listStyle`, `listReversed` and `listStart` values
-     * for the list that was merged.
-     *
-     * Consider the following model's content:
-     *
-     * ```xml
-     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 1</listItem>
-     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 2</listItem>
-     * <paragraph>[A paragraph.]</paragraph>
-     * <listItem listIndent="0" listType="bulleted" listStyle="circle">UL List item 1</listItem>
-     * <listItem listIndent="0" listType="bulleted" listStyle="circle">UL List item 2</listItem>
-     * ```
-     *
-     * After removing the paragraph element, the second list will be merged into the first one.
-     * We want to inherit the `listStyle` attribute for the second list from the first one.
-     *
-     * ```xml
-     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 1</listItem>
-     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 2</listItem>
-     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 1</listItem>
-     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 2</listItem>
-     * ```
-     *
-     * See https://github.com/ckeditor/ckeditor5/issues/7879.
-     *
-     * @param attributeStrategies Strategies for the enabled attributes.
-     */
-    private _mergeListAttributesWhileMergingLists;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/listproperties/listpropertiesediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+import ListEditing from '../list/listediting';
+/**
+ * The engine of the list properties feature.
+ *
+ * It sets the value for the `listItem` attribute of the {@link module:list/list~List `<listItem>`} element that
+ * allows modifying the list style type.
+ *
+ * It registers the `'listStyle'`, `'listReversed'` and `'listStart'` commands if they are enabled in the configuration.
+ * Read more in {@link module:list/listconfig~ListPropertiesConfig}.
+ */
+export default class ListPropertiesEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ListEditing];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ListPropertiesEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Starts listening to {@link module:engine/model/model~Model#deleteContent} and checks whether two lists will be merged into a single
+     * one after deleting the content.
+     *
+     * The purpose of this action is to adjust the `listStyle`, `listReversed` and `listStart` values
+     * for the list that was merged.
+     *
+     * Consider the following model's content:
+     *
+     * ```xml
+     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 1</listItem>
+     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 2</listItem>
+     * <paragraph>[A paragraph.]</paragraph>
+     * <listItem listIndent="0" listType="bulleted" listStyle="circle">UL List item 1</listItem>
+     * <listItem listIndent="0" listType="bulleted" listStyle="circle">UL List item 2</listItem>
+     * ```
+     *
+     * After removing the paragraph element, the second list will be merged into the first one.
+     * We want to inherit the `listStyle` attribute for the second list from the first one.
+     *
+     * ```xml
+     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 1</listItem>
+     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 2</listItem>
+     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 1</listItem>
+     * <listItem listIndent="0" listType="bulleted" listStyle="square">UL List item 2</listItem>
+     * ```
+     *
+     * See https://github.com/ckeditor/ckeditor5/issues/7879.
+     *
+     * @param attributeStrategies Strategies for the enabled attributes.
+     */
+    private _mergeListAttributesWhileMergingLists;
+}