@ckeditor/ckeditor5-list 0.0.0-internal-20241017.0

package/src/listproperties/ui/listpropertiesview.js

@@ -0,0 +1,301 @@
+/**
+ * @license Copyright (c) 2003-2024, 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/ui/listpropertiesview
+ */
+import { View, ViewCollection, FocusCycler, SwitchButtonView, LabeledFieldView, createLabeledInputNumber, addKeyboardHandlingForGrid, CollapsibleView } from 'ckeditor5/src/ui.js';
+import { FocusTracker, KeystrokeHandler, global } from 'ckeditor5/src/utils.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
+ */
+export default class ListPropertiesView extends View {
+    /**
+     * 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, { enabledProperties, styleButtonViews, styleGridAriaLabel }) {
+        super(locale);
+        /**
+         * A view that renders the grid of list styles.
+         */
+        this.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
+         */
+        this.additionalPropertiesCollapsibleView = 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
+         */
+        this.startIndexFieldView = null;
+        /**
+         * A switch button allowing the user to make the edited list reversed.
+         *
+         * **Note**: Only present when the view represents **numbered** list properties.
+         *
+         * @readonly
+         */
+        this.reversedSwitchButtonView = null;
+        /**
+         * Tracks information about the DOM focus in the view.
+         */
+        this.focusTracker = new FocusTracker();
+        /**
+         * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+         */
+        this.keystrokes = new KeystrokeHandler();
+        /**
+         * A collection of views that can be focused in the properties view.
+         */
+        this.focusables = new ViewCollection();
+        const elementCssClasses = [
+            'ck',
+            'ck-list-properties'
+        ];
+        this.children = this.createCollection();
+        this.focusCycler = new FocusCycler({
+            focusables: this.focusables,
+            focusTracker: this.focusTracker,
+            keystrokeHandler: this.keystrokes,
+            actions: {
+                // Navigate #children backwards using the <kbd>Shift</kbd> + <kbd>Tab</kbd> keystroke.
+                focusPrevious: 'shift + tab',
+                // Navigate #children forwards using the <kbd>Tab</kbd> key.
+                focusNext: 'tab'
+            }
+        });
+        // The rendering of the styles grid is conditional. When there is no styles grid, the view will render without collapsible
+        // for numbered list properties, hence simplifying the layout.
+        if (styleButtonViews && styleButtonViews.length) {
+            this.stylesView = this._createStylesView(styleButtonViews, styleGridAriaLabel);
+            this.children.add(this.stylesView);
+        }
+        else {
+            elementCssClasses.push('ck-list-properties_without-styles');
+        }
+        // The rendering of the numbered list property views is also conditional. It only makes sense for the numbered list
+        // dropdown. The unordered list does not have such properties.
+        if (enabledProperties.startIndex || enabledProperties.reversed) {
+            this._addNumberedListPropertyViews(enabledProperties);
+            elementCssClasses.push('ck-list-properties_with-numbered-properties');
+        }
+        this.setTemplate({
+            tag: 'div',
+            attributes: {
+                class: elementCssClasses
+            },
+            children: this.children
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    render() {
+        super.render();
+        if (this.stylesView) {
+            this.focusables.add(this.stylesView);
+            this.focusTracker.add(this.stylesView.element);
+            // Register the collapsible toggle button to the focus system.
+            if (this.startIndexFieldView || this.reversedSwitchButtonView) {
+                this.focusables.add(this.children.last.buttonView);
+                this.focusTracker.add(this.children.last.buttonView.element);
+            }
+            for (const item of this.stylesView.children) {
+                this.stylesView.focusTracker.add(item.element);
+            }
+            addKeyboardHandlingForGrid({
+                keystrokeHandler: this.stylesView.keystrokes,
+                focusTracker: this.stylesView.focusTracker,
+                gridItems: this.stylesView.children,
+                // Note: The styles view has a different number of columns depending on whether the other properties
+                // are enabled in the dropdown or not (https://github.com/ckeditor/ckeditor5/issues/12340)
+                numberOfColumns: () => global.window
+                    .getComputedStyle(this.stylesView.element)
+                    .getPropertyValue('grid-template-columns')
+                    .split(' ')
+                    .length,
+                uiLanguageDirection: this.locale && this.locale.uiLanguageDirection
+            });
+        }
+        if (this.startIndexFieldView) {
+            this.focusables.add(this.startIndexFieldView);
+            this.focusTracker.add(this.startIndexFieldView.element);
+            const stopPropagation = (data) => data.stopPropagation();
+            // Since the form is in the dropdown panel which is a child of the toolbar, the toolbar's
+            // keystroke handler would take over the key management in the input. We need to prevent
+            // this ASAP. Otherwise, the basic caret movement using the arrow keys will be impossible.
+            this.keystrokes.set('arrowright', stopPropagation);
+            this.keystrokes.set('arrowleft', stopPropagation);
+            this.keystrokes.set('arrowup', stopPropagation);
+            this.keystrokes.set('arrowdown', stopPropagation);
+        }
+        if (this.reversedSwitchButtonView) {
+            this.focusables.add(this.reversedSwitchButtonView);
+            this.focusTracker.add(this.reversedSwitchButtonView.element);
+        }
+        // Start listening for the keystrokes coming from #element.
+        this.keystrokes.listenTo(this.element);
+    }
+    /**
+     * @inheritDoc
+     */
+    focus() {
+        this.focusCycler.focusFirst();
+    }
+    /**
+     * @inheritDoc
+     */
+    focusLast() {
+        this.focusCycler.focusLast();
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        super.destroy();
+        this.focusTracker.destroy();
+        this.keystrokes.destroy();
+    }
+    /**
+     * Creates the list styles grid.
+     *
+     * @param styleButtons Buttons to be placed in the grid.
+     * @param styleGridAriaLabel The assistive technology label of the grid.
+     */
+    _createStylesView(styleButtons, styleGridAriaLabel) {
+        const stylesView = new View(this.locale);
+        stylesView.children = stylesView.createCollection();
+        stylesView.children.addMany(styleButtons);
+        stylesView.setTemplate({
+            tag: 'div',
+            attributes: {
+                'aria-label': styleGridAriaLabel,
+                class: [
+                    'ck',
+                    'ck-list-styles-list'
+                ]
+            },
+            children: stylesView.children
+        });
+        stylesView.children.delegate('execute').to(this);
+        stylesView.focus = function () {
+            this.children.first.focus();
+        };
+        stylesView.focusTracker = new FocusTracker();
+        stylesView.keystrokes = new KeystrokeHandler();
+        stylesView.render();
+        stylesView.keystrokes.listenTo(stylesView.element);
+        return stylesView;
+    }
+    /**
+     * 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}).
+     */
+    _addNumberedListPropertyViews(enabledProperties) {
+        const t = this.locale.t;
+        const numberedPropertyViews = [];
+        if (enabledProperties.startIndex) {
+            this.startIndexFieldView = this._createStartIndexField();
+            numberedPropertyViews.push(this.startIndexFieldView);
+        }
+        if (enabledProperties.reversed) {
+            this.reversedSwitchButtonView = this._createReversedSwitchButton();
+            numberedPropertyViews.push(this.reversedSwitchButtonView);
+        }
+        // When there are some style buttons, pack the numbered list properties into a collapsible to separate them.
+        if (this.stylesView) {
+            this.additionalPropertiesCollapsibleView = new CollapsibleView(this.locale, numberedPropertyViews);
+            this.additionalPropertiesCollapsibleView.set({
+                label: t('List properties'),
+                isCollapsed: true
+            });
+            // Don't enable the collapsible view unless either start index or reversed field is enabled (e.g. when no list is selected).
+            this.additionalPropertiesCollapsibleView.buttonView.bind('isEnabled').toMany(numberedPropertyViews, 'isEnabled', (...areEnabled) => areEnabled.some(isEnabled => isEnabled));
+            // Automatically collapse the additional properties collapsible when either start index or reversed field gets disabled.
+            this.additionalPropertiesCollapsibleView.buttonView.on('change:isEnabled', (evt, data, isEnabled) => {
+                if (!isEnabled) {
+                    this.additionalPropertiesCollapsibleView.isCollapsed = true;
+                }
+            });
+            this.children.add(this.additionalPropertiesCollapsibleView);
+        }
+        else {
+            this.children.addMany(numberedPropertyViews);
+        }
+    }
+    /**
+     * Creates the list start index labeled field.
+     */
+    _createStartIndexField() {
+        const t = this.locale.t;
+        const startIndexFieldView = new LabeledFieldView(this.locale, createLabeledInputNumber);
+        startIndexFieldView.set({
+            label: t('Start at'),
+            class: 'ck-numbered-list-properties__start-index'
+        });
+        startIndexFieldView.fieldView.set({
+            min: 0,
+            step: 1,
+            value: 1,
+            inputMode: 'numeric'
+        });
+        startIndexFieldView.fieldView.on('input', () => {
+            const inputElement = startIndexFieldView.fieldView.element;
+            const startIndex = inputElement.valueAsNumber;
+            if (Number.isNaN(startIndex)) {
+                // Number inputs allow for the entry of characters that may result in NaN,
+                // such as 'e', '+', '123e', '2-'.
+                startIndexFieldView.errorText = t('Invalid start index value.');
+                return;
+            }
+            if (!inputElement.checkValidity()) {
+                startIndexFieldView.errorText = t('Start index must be greater than 0.');
+            }
+            else {
+                this.fire('listStart', { startIndex });
+            }
+        });
+        return startIndexFieldView;
+    }
+    /**
+     * Creates the reversed list switch button.
+     */
+    _createReversedSwitchButton() {
+        const t = this.locale.t;
+        const reversedButtonView = new SwitchButtonView(this.locale);
+        reversedButtonView.set({
+            withText: true,
+            label: t('Reversed order'),
+            class: 'ck-numbered-list-properties__reversed-order'
+        });
+        reversedButtonView.delegate('execute').to(this, 'listReversed');
+        return reversedButtonView;
+    }
+}

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

@@ -0,0 +1,35 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+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
+ * }
+ * ```
+ *
+ * @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.
+*/
+export type NormalizedListPropertiesConfig = {
+    styles: {
+        listTypes: Array<ListPropertiesStyleListType>;
+        useAttribute: boolean;
+    };
+    startIndex: boolean;
+    reversed: boolean;
+};

package/src/listproperties/utils/config.js

@@ -0,0 +1,70 @@
+/**
+ * @license Copyright (c) 2003-2024, 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/utils/config
+ */
+import { toArray } from 'ckeditor5/src/utils.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
+ * }
+ * ```
+ *
+ * @param config The list properties {@link module:list/listconfig~ListPropertiesConfig config}.
+ * @returns An object with normalized list properties options.
+ */
+export function getNormalizedConfig(config) {
+    const { startIndex, reversed, styles } = config;
+    return {
+        styles: getNormalizedStylesConfig(styles),
+        startIndex: startIndex || false,
+        reversed: reversed || false
+    };
+}
+/**
+ * Normalizes styles in the configuration of the list properties feature.
+ * The structure of normalized list properties options looks as follows:
+ *
+ * ```ts
+ * {
+ * 	listTypes: [ 'bulleted', 'numbered' ],
+ * 	useAttribute: false
+ * }
+ * ```
+ *
+ * @param styles The list properties styles.
+ * @returns An object with normalized list properties styles.
+ */
+function getNormalizedStylesConfig(styles) {
+    const normalizedConfig = {
+        listTypes: ['bulleted', 'numbered'],
+        useAttribute: false
+    };
+    if (styles === true) {
+        return normalizedConfig;
+    }
+    if (!styles) {
+        normalizedConfig.listTypes = [];
+    }
+    else if (Array.isArray(styles) || typeof styles == 'string') {
+        normalizedConfig.listTypes = toArray(styles);
+    }
+    else {
+        normalizedConfig.listTypes = styles.listTypes ?
+            toArray(styles.listTypes) :
+            normalizedConfig.listTypes;
+        normalizedConfig.useAttribute = !!styles.useAttribute;
+    }
+    return normalizedConfig;
+}

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

@@ -0,0 +1,20 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * Gets all the style types supported by given list type.
+ */
+export declare function getAllSupportedStyleTypes(): Array<string>;
+/**
+ * Checks whether the given list-style-type is supported by numbered or bulleted list.
+ */
+export declare function getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;
+/**
+ * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
+ */
+export declare function getListStyleTypeFromTypeAttribute(value: string): string | null;
+/**
+ * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
+ */
+export declare function getTypeAttributeFromListStyleType(value: string): string | null;

package/src/listproperties/utils/style.js

@@ -0,0 +1,54 @@
+/**
+ * @license Copyright (c) 2003-2024, 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/utils/style
+*/
+const LIST_STYLE_TO_LIST_TYPE = {};
+const LIST_STYLE_TO_TYPE_ATTRIBUTE = {};
+const TYPE_ATTRIBUTE_TO_LIST_STYLE = {};
+const LIST_STYLE_TYPES = [
+    { listStyle: 'disc', typeAttribute: 'disc', listType: 'bulleted' },
+    { listStyle: 'circle', typeAttribute: 'circle', listType: 'bulleted' },
+    { listStyle: 'square', typeAttribute: 'square', listType: 'bulleted' },
+    { listStyle: 'decimal', typeAttribute: '1', listType: 'numbered' },
+    { listStyle: 'decimal-leading-zero', typeAttribute: null, listType: 'numbered' },
+    { listStyle: 'lower-roman', typeAttribute: 'i', listType: 'numbered' },
+    { listStyle: 'upper-roman', typeAttribute: 'I', listType: 'numbered' },
+    { listStyle: 'lower-alpha', typeAttribute: 'a', listType: 'numbered' },
+    { listStyle: 'upper-alpha', typeAttribute: 'A', listType: 'numbered' },
+    { listStyle: 'lower-latin', typeAttribute: 'a', listType: 'numbered' },
+    { listStyle: 'upper-latin', typeAttribute: 'A', listType: 'numbered' }
+];
+for (const { listStyle, typeAttribute, listType } of LIST_STYLE_TYPES) {
+    LIST_STYLE_TO_LIST_TYPE[listStyle] = listType;
+    LIST_STYLE_TO_TYPE_ATTRIBUTE[listStyle] = typeAttribute;
+    if (typeAttribute) {
+        TYPE_ATTRIBUTE_TO_LIST_STYLE[typeAttribute] = listStyle;
+    }
+}
+/**
+ * Gets all the style types supported by given list type.
+ */
+export function getAllSupportedStyleTypes() {
+    return LIST_STYLE_TYPES.map(x => x.listStyle);
+}
+/**
+ * Checks whether the given list-style-type is supported by numbered or bulleted list.
+ */
+export function getListTypeFromListStyleType(listStyleType) {
+    return LIST_STYLE_TO_LIST_TYPE[listStyleType] || null;
+}
+/**
+ * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
+ */
+export function getListStyleTypeFromTypeAttribute(value) {
+    return TYPE_ATTRIBUTE_TO_LIST_STYLE[value] || null;
+}
+/**
+ * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
+ */
+export function getTypeAttributeFromListStyleType(value) {
+    return LIST_STYLE_TO_TYPE_ATTRIBUTE[value] || null;
+}

package/src/listproperties.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license Copyright (c) 2003-2024, 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
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+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}.
+ */
+export default class ListProperties extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ListPropertiesEditing, typeof ListPropertiesUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ListProperties";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+}

package/src/listproperties.js

@@ -0,0 +1,37 @@
+/**
+ * @license Copyright (c) 2003-2024, 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
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+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}.
+ */
+export default class ListProperties extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ListPropertiesEditing, ListPropertiesUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ListProperties';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/tododocumentlist.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/tododocumentlist
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import TodoList from './todolist.js';
+/**
+ * The to-do list feature.
+ *
+ * This is an obsolete plugin that exists for backward compatibility only.
+ * Use the {@link module:list/todolist~TodoList `TodoList`} instead.
+ *
+ * @deprecated
+ */
+export default class TodoDocumentList extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TodoList];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TodoDocumentList";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    constructor(editor: Editor);
+}

package/src/tododocumentlist.js

@@ -0,0 +1,47 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/tododocumentlist
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { logWarning } from 'ckeditor5/src/utils.js';
+import TodoList from './todolist.js';
+/**
+ * The to-do list feature.
+ *
+ * This is an obsolete plugin that exists for backward compatibility only.
+ * Use the {@link module:list/todolist~TodoList `TodoList`} instead.
+ *
+ * @deprecated
+ */
+export default class TodoDocumentList extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [TodoList];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TodoDocumentList';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    constructor(editor) {
+        super(editor);
+        /**
+         * The `TodoDocumentList` plugin is obsolete. Use `TodoList` instead.
+         *
+         * @error plugin-obsolete-tododocumentlist
+         */
+        logWarning('plugin-obsolete-tododocumentlist', { pluginName: 'TodoDocumentList' });
+    }
+}

package/src/todolist/checktodolistcommand.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/todolist/checktodolistcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * The check to-do command.
+ *
+ * The command is registered by the {@link module:list/todolist/todolistediting~TodoListEditing} as
+ * the `checkTodoList` editor command.
+ */
+export default class CheckTodoListCommand extends Command {
+    /**
+     * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
+     *
+     * @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~Selection}.
+     */
+    private _getSelectedItems;
+}