@ckeditor/ckeditor5-list 39.0.2 → 40.0.0

package/src/documentlistproperties/documentlistpropertiesutils.js

@@ -1,44 +1,44 @@
-/**
- * @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/documentlistproperties/documentlistpropertiesutils
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { getAllSupportedStyleTypes, getListStyleTypeFromTypeAttribute, getListTypeFromListStyleType, getTypeAttributeFromListStyleType } from './utils/style';
-/**
- * A set of helpers related to document lists.
- */
-export default class DocumentListPropertiesUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'DocumentListPropertiesUtils';
-    }
-    /**
-     * Gets all the style types supported by given list type.
-     */
-    getAllSupportedStyleTypes() {
-        return getAllSupportedStyleTypes();
-    }
-    /**
-     * Checks whether the given list-style-type is supported by numbered or bulleted list.
-     */
-    getListTypeFromListStyleType(listStyleType) {
-        return getListTypeFromListStyleType(listStyleType);
-    }
-    /**
-     * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
-     */
-    getListStyleTypeFromTypeAttribute(value) {
-        return getListStyleTypeFromTypeAttribute(value);
-    }
-    /**
-     * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
-     */
-    getTypeAttributeFromListStyleType(value) {
-        return getTypeAttributeFromListStyleType(value);
-    }
-}
+/**
+ * @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/documentlistproperties/documentlistpropertiesutils
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { getAllSupportedStyleTypes, getListStyleTypeFromTypeAttribute, getListTypeFromListStyleType, getTypeAttributeFromListStyleType } from './utils/style';
+/**
+ * A set of helpers related to document lists.
+ */
+export default class DocumentListPropertiesUtils extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'DocumentListPropertiesUtils';
+    }
+    /**
+     * Gets all the style types supported by given list type.
+     */
+    getAllSupportedStyleTypes() {
+        return getAllSupportedStyleTypes();
+    }
+    /**
+     * Checks whether the given list-style-type is supported by numbered or bulleted list.
+     */
+    getListTypeFromListStyleType(listStyleType) {
+        return getListTypeFromListStyleType(listStyleType);
+    }
+    /**
+     * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
+     */
+    getListStyleTypeFromTypeAttribute(value) {
+        return getListStyleTypeFromTypeAttribute(value);
+    }
+    /**
+     * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
+     */
+    getTypeAttributeFromListStyleType(value) {
+        return getTypeAttributeFromListStyleType(value);
+    }
+}

package/src/documentlistproperties/documentlistreversedcommand.d.ts

@@ -1,36 +1,36 @@
-/**
- * @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/documentlistproperties/documentlistreversedcommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The list reversed command. It changes the `listReversed` attribute of the selected list items,
- * letting the user to choose the order of an ordered list.
- * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- */
-export default class DocumentListReversedCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    value: boolean | null;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.reversed Whether the list should be reversed.
-     */
-    execute(options?: {
-        reversed?: boolean;
-    }): void;
-    /**
-     * Checks the command's {@link #value}.
-     */
-    private _getValue;
-}
+/**
+ * @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/documentlistproperties/documentlistreversedcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The list reversed command. It changes the `listReversed` attribute of the selected list items,
+ * letting the user to choose the order of an ordered list.
+ * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
+ */
+export default class DocumentListReversedCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    value: boolean | null;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options.reversed Whether the list should be reversed.
+     */
+    execute(options?: {
+        reversed?: boolean;
+    }): void;
+    /**
+     * Checks the command's {@link #value}.
+     */
+    private _getValue;
+}

package/src/documentlistproperties/documentlistreversedcommand.js

@@ -1,55 +1,55 @@
-/**
- * @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/documentlistproperties/documentlistreversedcommand
- */
-import { Command } from 'ckeditor5/src/core';
-import { first } from 'ckeditor5/src/utils';
-import { expandListBlocksToCompleteList, isListItemBlock } from '../documentlist/utils/model';
-/**
- * The list reversed command. It changes the `listReversed` attribute of the selected list items,
- * letting the user to choose the order of an ordered list.
- * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- */
-export default class DocumentListReversedCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const value = this._getValue();
-        this.value = value;
-        this.isEnabled = value != null;
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.reversed Whether the list should be reversed.
-     */
-    execute(options = {}) {
-        const model = this.editor.model;
-        const document = model.document;
-        let blocks = Array.from(document.selection.getSelectedBlocks())
-            .filter(block => isListItemBlock(block) && block.getAttribute('listType') == 'numbered');
-        blocks = expandListBlocksToCompleteList(blocks);
-        model.change(writer => {
-            for (const block of blocks) {
-                writer.setAttribute('listReversed', !!options.reversed, block);
-            }
-        });
-    }
-    /**
-     * Checks the command's {@link #value}.
-     */
-    _getValue() {
-        const model = this.editor.model;
-        const document = model.document;
-        const block = first(document.selection.getSelectedBlocks());
-        if (isListItemBlock(block) && block.getAttribute('listType') == 'numbered') {
-            return block.getAttribute('listReversed');
-        }
-        return null;
-    }
-}
+/**
+ * @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/documentlistproperties/documentlistreversedcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+import { first } from 'ckeditor5/src/utils';
+import { expandListBlocksToCompleteList, isListItemBlock } from '../documentlist/utils/model';
+/**
+ * The list reversed command. It changes the `listReversed` attribute of the selected list items,
+ * letting the user to choose the order of an ordered list.
+ * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
+ */
+export default class DocumentListReversedCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const value = this._getValue();
+        this.value = value;
+        this.isEnabled = value != null;
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options.reversed Whether the list should be reversed.
+     */
+    execute(options = {}) {
+        const model = this.editor.model;
+        const document = model.document;
+        let blocks = Array.from(document.selection.getSelectedBlocks())
+            .filter(block => isListItemBlock(block) && block.getAttribute('listType') == 'numbered');
+        blocks = expandListBlocksToCompleteList(blocks);
+        model.change(writer => {
+            for (const block of blocks) {
+                writer.setAttribute('listReversed', !!options.reversed, block);
+            }
+        });
+    }
+    /**
+     * Checks the command's {@link #value}.
+     */
+    _getValue() {
+        const model = this.editor.model;
+        const document = model.document;
+        const block = first(document.selection.getSelectedBlocks());
+        if (isListItemBlock(block) && block.getAttribute('listType') == 'numbered') {
+            return block.getAttribute('listReversed');
+        }
+        return null;
+    }
+}

package/src/documentlistproperties/documentliststartcommand.d.ts

@@ -1,38 +1,38 @@
-/**
- * @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/documentlistproperties/documentliststartcommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The list start index command. It changes the `listStart` attribute of the selected list items,
- * letting the user to choose the starting point of an ordered list.
- * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- */
-export default class DocumentListStartCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    value: number | null;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.startIndex The list start index.
-     */
-    execute({ startIndex }?: {
-        startIndex?: number;
-    }): void;
-    /**
-     * Checks the command's {@link #value}.
-     *
-     * @returns The current value.
-     */
-    private _getValue;
-}
+/**
+ * @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/documentlistproperties/documentliststartcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The list start index command. It changes the `listStart` attribute of the selected list items,
+ * letting the user to choose the starting point of an ordered list.
+ * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
+ */
+export default class DocumentListStartCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    value: number | null;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options.startIndex The list start index.
+     */
+    execute({ startIndex }?: {
+        startIndex?: number;
+    }): void;
+    /**
+     * Checks the command's {@link #value}.
+     *
+     * @returns The current value.
+     */
+    private _getValue;
+}

package/src/documentlistproperties/documentliststartcommand.js

@@ -1,57 +1,57 @@
-/**
- * @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/documentlistproperties/documentliststartcommand
- */
-import { Command } from 'ckeditor5/src/core';
-import { first } from 'ckeditor5/src/utils';
-import { expandListBlocksToCompleteList, isListItemBlock } from '../documentlist/utils/model';
-/**
- * The list start index command. It changes the `listStart` attribute of the selected list items,
- * letting the user to choose the starting point of an ordered list.
- * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- */
-export default class DocumentListStartCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const value = this._getValue();
-        this.value = value;
-        this.isEnabled = value != null;
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.startIndex The list start index.
-     */
-    execute({ startIndex = 1 } = {}) {
-        const model = this.editor.model;
-        const document = model.document;
-        let blocks = Array.from(document.selection.getSelectedBlocks())
-            .filter(block => isListItemBlock(block) && block.getAttribute('listType') == 'numbered');
-        blocks = expandListBlocksToCompleteList(blocks);
-        model.change(writer => {
-            for (const block of blocks) {
-                writer.setAttribute('listStart', startIndex >= 0 ? startIndex : 1, block);
-            }
-        });
-    }
-    /**
-     * Checks the command's {@link #value}.
-     *
-     * @returns The current value.
-     */
-    _getValue() {
-        const model = this.editor.model;
-        const document = model.document;
-        const block = first(document.selection.getSelectedBlocks());
-        if (block && isListItemBlock(block) && block.getAttribute('listType') == 'numbered') {
-            return block.getAttribute('listStart');
-        }
-        return null;
-    }
-}
+/**
+ * @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/documentlistproperties/documentliststartcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+import { first } from 'ckeditor5/src/utils';
+import { expandListBlocksToCompleteList, isListItemBlock } from '../documentlist/utils/model';
+/**
+ * The list start index command. It changes the `listStart` attribute of the selected list items,
+ * letting the user to choose the starting point of an ordered list.
+ * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
+ */
+export default class DocumentListStartCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const value = this._getValue();
+        this.value = value;
+        this.isEnabled = value != null;
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options.startIndex The list start index.
+     */
+    execute({ startIndex = 1 } = {}) {
+        const model = this.editor.model;
+        const document = model.document;
+        let blocks = Array.from(document.selection.getSelectedBlocks())
+            .filter(block => isListItemBlock(block) && block.getAttribute('listType') == 'numbered');
+        blocks = expandListBlocksToCompleteList(blocks);
+        model.change(writer => {
+            for (const block of blocks) {
+                writer.setAttribute('listStart', startIndex >= 0 ? startIndex : 1, block);
+            }
+        });
+    }
+    /**
+     * Checks the command's {@link #value}.
+     *
+     * @returns The current value.
+     */
+    _getValue() {
+        const model = this.editor.model;
+        const document = model.document;
+        const block = first(document.selection.getSelectedBlocks());
+        if (block && isListItemBlock(block) && block.getAttribute('listType') == 'numbered') {
+            return block.getAttribute('listStart');
+        }
+        return null;
+    }
+}

package/src/documentlistproperties/documentliststylecommand.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/documentlistproperties/documentliststylecommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core';
-/**
- * The list style command. It changes `listStyle` attribute of the selected list items,
- * letting the user choose styles for the list item markers.
- * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- */
-export default class DocumentListStyleCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    value: string | null;
-    /**
-     * The default type of the list style.
-     */
-    readonly defaultType: string;
-    /**
-     * The list of supported style types by this command.
-     */
-    private _supportedTypes;
-    /**
-     * 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.
-     * @param supportedTypes The list of supported style types by this command.
-     */
-    constructor(editor: Editor, defaultType: string, supportedTypes?: Array<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 if the given style type is supported by this plugin.
-     */
-    isStyleTypeSupported(value: string): boolean;
-    /**
-     * 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;
-    /**
-     * Check if the provided list style is valid. Also change the selection to a list if it's not set yet.
-     *
-     * @param options.type The type of the list style. If `null` is specified, the function does nothing.
-    */
-    private _tryToConvertItemsToList;
-}
+/**
+ * @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/documentlistproperties/documentliststylecommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+/**
+ * The list style command. It changes `listStyle` attribute of the selected list items,
+ * letting the user choose styles for the list item markers.
+ * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
+ */
+export default class DocumentListStyleCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    value: string | null;
+    /**
+     * The default type of the list style.
+     */
+    readonly defaultType: string;
+    /**
+     * The list of supported style types by this command.
+     */
+    private _supportedTypes;
+    /**
+     * 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.
+     * @param supportedTypes The list of supported style types by this command.
+     */
+    constructor(editor: Editor, defaultType: string, supportedTypes?: Array<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 if the given style type is supported by this plugin.
+     */
+    isStyleTypeSupported(value: string): boolean;
+    /**
+     * 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;
+    /**
+     * Check if the provided list style is valid. Also change the selection to a list if it's not set yet.
+     *
+     * @param options.type The type of the list style. If `null` is specified, the function does nothing.
+    */
+    private _tryToConvertItemsToList;
+}