@ckeditor/ckeditor5-list 40.0.0 → 40.2.0

package/src/listproperties.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/listproperties
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ListPropertiesEditing from './listproperties/listpropertiesediting';
-import ListPropertiesUI from './listproperties/listpropertiesui';
-/**
- * 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";
-}
+/**
+ * @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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ListPropertiesEditing from './listproperties/listpropertiesediting';
+import ListPropertiesUI from './listproperties/listpropertiesui';
+/**
+ * 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";
+}

package/src/listproperties.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/listproperties
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ListPropertiesEditing from './listproperties/listpropertiesediting';
-import ListPropertiesUI from './listproperties/listpropertiesui';
-/**
- * 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';
-    }
-}
+/**
+ * @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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ListPropertiesEditing from './listproperties/listpropertiesediting';
+import ListPropertiesUI from './listproperties/listpropertiesui';
+/**
+ * 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';
+    }
+}

package/src/liststyle.d.ts

@@ -1,28 +1,28 @@
-/**
- * @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/liststyle
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-import ListProperties from './listproperties';
-/**
- * The list style feature.
- *
- * This is an obsolete plugin that exists for backward compatibility only.
- * Use the {@link module:list/listproperties~ListProperties list properties plugin} instead.
- *
- * @deprecated
- */
-export default class ListStyle extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ListProperties];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListStyle";
-    constructor(editor: Editor);
-}
+/**
+ * @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/liststyle
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+import ListProperties from './listproperties';
+/**
+ * The list style feature.
+ *
+ * This is an obsolete plugin that exists for backward compatibility only.
+ * Use the {@link module:list/listproperties~ListProperties list properties plugin} instead.
+ *
+ * @deprecated
+ */
+export default class ListStyle extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ListProperties];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ListStyle";
+    constructor(editor: Editor);
+}

package/src/liststyle.js

@@ -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/liststyle
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ListProperties from './listproperties';
-import { logWarning } from 'ckeditor5/src/utils';
-/**
- * The list style feature.
- *
- * This is an obsolete plugin that exists for backward compatibility only.
- * Use the {@link module:list/listproperties~ListProperties list properties plugin} instead.
- *
- * @deprecated
- */
-export default class ListStyle extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [ListProperties];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ListStyle';
-    }
-    constructor(editor) {
-        super(editor);
-        logWarning('The `ListStyle` plugin is obsolete. Use `ListProperties` instead.');
-    }
-}
+/**
+ * @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/liststyle
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ListProperties from './listproperties';
+import { logWarning } from 'ckeditor5/src/utils';
+/**
+ * The list style feature.
+ *
+ * This is an obsolete plugin that exists for backward compatibility only.
+ * Use the {@link module:list/listproperties~ListProperties list properties plugin} instead.
+ *
+ * @deprecated
+ */
+export default class ListStyle extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ListProperties];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ListStyle';
+    }
+    constructor(editor) {
+        super(editor);
+        logWarning('The `ListStyle` plugin is obsolete. Use `ListProperties` instead.');
+    }
+}

package/src/tododocumentlist/checktododocumentlistcommand.d.ts

@@ -1,49 +1,49 @@
-/**
- * @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/tododocumentlist/checktododocumentlistcommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core';
-/**
- * The check to-do command.
- *
- * The command is registered by the {@link module:list/tododocumentlist/tododocumentlistediting~TodoDocumentListEditing} as
- * the `checkTodoList` editor command.
- */
-export default class CheckTodoDocumentListCommand 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;
-}
+/**
+ * @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/tododocumentlist/checktododocumentlistcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+/**
+ * The check to-do command.
+ *
+ * The command is registered by the {@link module:list/tododocumentlist/tododocumentlistediting~TodoDocumentListEditing} as
+ * the `checkTodoList` editor command.
+ */
+export default class CheckTodoDocumentListCommand 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;
+}

package/src/tododocumentlist/checktododocumentlistcommand.js

@@ -1,82 +1,82 @@
-/**
- * @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/tododocumentlist/checktododocumentlistcommand
- */
-import { Command } from 'ckeditor5/src/core';
-import { getAllListItemBlocks } from '../documentlist/utils/model';
-/**
- * The check to-do command.
- *
- * The command is registered by the {@link module:list/tododocumentlist/tododocumentlistediting~TodoDocumentListEditing} as
- * the `checkTodoList` editor command.
- */
-export default class CheckTodoDocumentListCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        // Refresh command before executing to be sure all values are up to date.
-        // It is needed when selection has changed before command execution, in the same change block.
-        this.on('execute', () => {
-            this.refresh();
-        }, { priority: 'highest' });
-    }
-    /**
-     * Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
-     */
-    refresh() {
-        const selectedElements = this._getSelectedItems();
-        this.value = this._getValue(selectedElements);
-        this.isEnabled = !!selectedElements.length;
-    }
-    /**
-     * 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 = {}) {
-        this.editor.model.change(writer => {
-            const selectedElements = this._getSelectedItems();
-            const value = (options.forceValue === undefined) ? !this._getValue(selectedElements) : options.forceValue;
-            for (const element of selectedElements) {
-                if (value) {
-                    writer.setAttribute('todoListChecked', true, element);
-                }
-                else {
-                    writer.removeAttribute('todoListChecked', element);
-                }
-            }
-        });
-    }
-    /**
-     * Returns a value for the command.
-     */
-    _getValue(selectedElements) {
-        return selectedElements.every(element => element.getAttribute('todoListChecked'));
-    }
-    /**
-     * Gets all to-do list items selected by the {@link module:engine/model/selection~Selection}.
-     */
-    _getSelectedItems() {
-        const model = this.editor.model;
-        const schema = model.schema;
-        const selectionRange = model.document.selection.getFirstRange();
-        const startElement = selectionRange.start.parent;
-        const elements = [];
-        if (schema.checkAttribute(startElement, 'todoListChecked')) {
-            elements.push(...getAllListItemBlocks(startElement));
-        }
-        for (const item of selectionRange.getItems({ shallow: true })) {
-            if (schema.checkAttribute(item, 'todoListChecked') && !elements.includes(item)) {
-                elements.push(...getAllListItemBlocks(item));
-            }
-        }
-        return elements;
-    }
-}
+/**
+ * @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/tododocumentlist/checktododocumentlistcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+import { getAllListItemBlocks } from '../documentlist/utils/model';
+/**
+ * The check to-do command.
+ *
+ * The command is registered by the {@link module:list/tododocumentlist/tododocumentlistediting~TodoDocumentListEditing} as
+ * the `checkTodoList` editor command.
+ */
+export default class CheckTodoDocumentListCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        // Refresh command before executing to be sure all values are up to date.
+        // It is needed when selection has changed before command execution, in the same change block.
+        this.on('execute', () => {
+            this.refresh();
+        }, { priority: 'highest' });
+    }
+    /**
+     * Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
+     */
+    refresh() {
+        const selectedElements = this._getSelectedItems();
+        this.value = this._getValue(selectedElements);
+        this.isEnabled = !!selectedElements.length;
+    }
+    /**
+     * 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 = {}) {
+        this.editor.model.change(writer => {
+            const selectedElements = this._getSelectedItems();
+            const value = (options.forceValue === undefined) ? !this._getValue(selectedElements) : options.forceValue;
+            for (const element of selectedElements) {
+                if (value) {
+                    writer.setAttribute('todoListChecked', true, element);
+                }
+                else {
+                    writer.removeAttribute('todoListChecked', element);
+                }
+            }
+        });
+    }
+    /**
+     * Returns a value for the command.
+     */
+    _getValue(selectedElements) {
+        return selectedElements.every(element => element.getAttribute('todoListChecked'));
+    }
+    /**
+     * Gets all to-do list items selected by the {@link module:engine/model/selection~Selection}.
+     */
+    _getSelectedItems() {
+        const model = this.editor.model;
+        const schema = model.schema;
+        const selectionRange = model.document.selection.getFirstRange();
+        const startElement = selectionRange.start.parent;
+        const elements = [];
+        if (schema.checkAttribute(startElement, 'todoListChecked')) {
+            elements.push(...getAllListItemBlocks(startElement));
+        }
+        for (const item of selectionRange.getItems({ shallow: true })) {
+            if (schema.checkAttribute(item, 'todoListChecked') && !elements.includes(item)) {
+                elements.push(...getAllListItemBlocks(item));
+            }
+        }
+        return elements;
+    }
+}

package/src/tododocumentlist/todocheckboxchangeobserver.d.ts

@@ -1,41 +1,41 @@
-/**
- * @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/tododocumentlist/todocheckboxchangeobserver
- */
-import { DomEventObserver, type DomEventData } from 'ckeditor5/src/engine';
-/**
- * Observes all to-do list checkboxes state changes.
- *
- * Note that this observer is not available by default. To make it available it needs to be added to
- * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
- */
-export default class TodoCheckboxChangeObserver extends DomEventObserver<'change'> {
-    /**
-     * @inheritDoc
-     */
-    readonly domEventType: readonly ["change"];
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent: Event): void;
-}
-/**
- * Fired when the to-do list checkbox is toggled.
- *
- * Introduced by {@link module:list/tododocumentlist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}.
- *
- * Note that this event is not available by default. To make it available,
- * {@link module:list/tododocumentlist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
- *
- * @see module:list/tododocumentlist/todocheckboxchangeobserver~TodoCheckboxChangeObserver
- * @eventName module:engine/view/document~Document#todoCheckboxChange
- * @param data The event data.
- */
-export type ViewDocumentTodoCheckboxChangeEvent = {
-    name: 'todoCheckboxChange';
-    args: [data: DomEventData<Event>];
-};
+/**
+ * @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/tododocumentlist/todocheckboxchangeobserver
+ */
+import { DomEventObserver, type DomEventData } from 'ckeditor5/src/engine';
+/**
+ * Observes all to-do list checkboxes state changes.
+ *
+ * Note that this observer is not available by default. To make it available it needs to be added to
+ * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
+ */
+export default class TodoCheckboxChangeObserver extends DomEventObserver<'change'> {
+    /**
+     * @inheritDoc
+     */
+    readonly domEventType: readonly ["change"];
+    /**
+     * @inheritDoc
+     */
+    onDomEvent(domEvent: Event): void;
+}
+/**
+ * Fired when the to-do list checkbox is toggled.
+ *
+ * Introduced by {@link module:list/tododocumentlist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}.
+ *
+ * Note that this event is not available by default. To make it available,
+ * {@link module:list/tododocumentlist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}
+ * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
+ *
+ * @see module:list/tododocumentlist/todocheckboxchangeobserver~TodoCheckboxChangeObserver
+ * @eventName module:engine/view/document~Document#todoCheckboxChange
+ * @param data The event data.
+ */
+export type ViewDocumentTodoCheckboxChangeEvent = {
+    name: 'todoCheckboxChange';
+    args: [data: DomEventData<Event>];
+};