@ckeditor/ckeditor5-list 0.0.0-internal-20241017.0

package/src/legacylistproperties/legacylistreversedcommand.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @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/legacylistproperties/legacylistreversedcommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * The reversed list command. It changes the `listReversed` attribute of the selected list items. As a result, the list order will be
+ * reversed.
+ * It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
+ */
+export default class LegacyListReversedCommand 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}.
+     *
+     * @returns The current value.
+     */
+    private _getValue;
+}

package/src/legacylistproperties/legacylistreversedcommand.js

@@ -0,0 +1,52 @@
+/**
+ * @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/legacylistproperties/legacylistreversedcommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+import { getSelectedListItems } from '../legacylist/legacyutils.js';
+/**
+ * The reversed list command. It changes the `listReversed` attribute of the selected list items. As a result, the list order will be
+ * reversed.
+ * It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
+ */
+export default class LegacyListReversedCommand 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 listItems = getSelectedListItems(model)
+            .filter(item => item.getAttribute('listType') == 'numbered');
+        model.change(writer => {
+            for (const item of listItems) {
+                writer.setAttribute('listReversed', !!options.reversed, item);
+            }
+        });
+    }
+    /**
+     * Checks the command's {@link #value}.
+     *
+     * @returns The current value.
+     */
+    _getValue() {
+        const listItem = this.editor.model.document.selection.getFirstPosition().parent;
+        if (listItem && listItem.is('element', 'listItem') && listItem.getAttribute('listType') == 'numbered') {
+            return listItem.getAttribute('listReversed');
+        }
+        return null;
+    }
+}

package/src/legacylistproperties/legacyliststartcommand.d.ts

@@ -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/legacylistproperties/legacyliststartcommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * The list start index command. It changes the `listStart` attribute of the selected list items.
+ * It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
+ */
+export default class LegacyListStartCommand 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/legacylistproperties/legacyliststartcommand.js

@@ -0,0 +1,51 @@
+/**
+ * @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/legacylistproperties/legacyliststartcommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+import { getSelectedListItems } from '../legacylist/legacyutils.js';
+/**
+ * The list start index command. It changes the `listStart` attribute of the selected list items.
+ * It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
+ */
+export default class LegacyListStartCommand 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 listItems = getSelectedListItems(model)
+            .filter(item => item.getAttribute('listType') == 'numbered');
+        model.change(writer => {
+            for (const item of listItems) {
+                writer.setAttribute('listStart', startIndex >= 0 ? startIndex : 1, item);
+            }
+        });
+    }
+    /**
+     * Checks the command's {@link #value}.
+     *
+     * @returns The current value.
+     */
+    _getValue() {
+        const listItem = this.editor.model.document.selection.getFirstPosition().parent;
+        if (listItem && listItem.is('element', 'listItem') && listItem.getAttribute('listType') == 'numbered') {
+            return listItem.getAttribute('listStart');
+        }
+        return null;
+    }
+}

package/src/legacylistproperties/legacyliststylecommand.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @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/legacylistproperties/legacyliststylecommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * The list style command. It changes the `listStyle` attribute of the selected list items.
+ *
+ * If the list type (numbered or bulleted) can be inferred from the passed style type,
+ * the command tries to convert selected items to a list of that type.
+ * It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
+ */
+export default class LegacyListStyleCommand extends Command {
+    isStyleTypeSupported: undefined;
+    /**
+     * @inheritDoc
+     * @readonly
+     */
+    value: string | null;
+    /**
+     * The default type of the list style.
+     */
+    readonly defaultType: string;
+    /**
+     * 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.
+     */
+    constructor(editor: Editor, defaultType: 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 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;
+    /**
+     * Checks if the provided list style is valid. Also changes the selection to a list if it's not set yet.
+     *
+     * @param The type of the list style. If `null` is specified, the function does nothing.
+    */
+    private _tryToConvertItemsToList;
+}

package/src/legacylistproperties/legacyliststylecommand.js

@@ -0,0 +1,100 @@
+/**
+ * @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/legacylistproperties/legacyliststylecommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+import { getListTypeFromListStyleType, getSelectedListItems } from '../legacylist/legacyutils.js';
+/**
+ * The list style command. It changes the `listStyle` attribute of the selected list items.
+ *
+ * If the list type (numbered or bulleted) can be inferred from the passed style type,
+ * the command tries to convert selected items to a list of that type.
+ * It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
+ */
+export default class LegacyListStyleCommand extends Command {
+    /**
+     * 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.
+     */
+    constructor(editor, defaultType) {
+        super(editor);
+        this.defaultType = defaultType;
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        this.value = this._getValue();
+        this.isEnabled = this._checkEnabled();
+    }
+    /**
+     * 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 = {}) {
+        this._tryToConvertItemsToList(options);
+        const model = this.editor.model;
+        const listItems = getSelectedListItems(model);
+        if (!listItems.length) {
+            return;
+        }
+        model.change(writer => {
+            for (const item of listItems) {
+                writer.setAttribute('listStyle', options.type || this.defaultType, item);
+            }
+        });
+    }
+    /**
+     * Checks the command's {@link #value}.
+     *
+     * @returns The current value.
+     */
+    _getValue() {
+        const listItem = this.editor.model.document.selection.getFirstPosition().parent;
+        if (listItem && listItem.is('element', 'listItem')) {
+            return listItem.getAttribute('listStyle');
+        }
+        return null;
+    }
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    _checkEnabled() {
+        const editor = this.editor;
+        const numberedList = editor.commands.get('numberedList');
+        const bulletedList = editor.commands.get('bulletedList');
+        return numberedList.isEnabled || bulletedList.isEnabled;
+    }
+    /**
+     * Checks if the provided list style is valid. Also changes the selection to a list if it's not set yet.
+     *
+     * @param The type of the list style. If `null` is specified, the function does nothing.
+    */
+    _tryToConvertItemsToList(options) {
+        if (!options.type) {
+            return;
+        }
+        const listType = getListTypeFromListStyleType(options.type);
+        /* istanbul ignore next -- @preserve */
+        if (!listType) {
+            return;
+        }
+        const editor = this.editor;
+        const commandName = `${listType}List`;
+        const command = editor.commands.get(commandName);
+        if (!command.value) {
+            editor.execute(commandName);
+        }
+    }
+}

package/src/legacylistproperties.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/legacylistproperties
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import LegacyListPropertiesEditing from './legacylistproperties/legacylistpropertiesediting.js';
+import ListPropertiesUI from './listproperties/listpropertiesui.js';
+/**
+ * The legacy list properties feature.
+ *
+ * This is a "glue" plugin that loads the {@link module:list/legacylistproperties/legacylistpropertiesediting~LegacyListPropertiesEditing
+ * legacy list properties editing feature} and the
+ * {@link module:list/listproperties/listpropertiesui~ListPropertiesUI list properties UI feature}.
+ */
+export default class LegacyListProperties extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof LegacyListPropertiesEditing, typeof ListPropertiesUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "LegacyListProperties";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+}

package/src/legacylistproperties.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/legacylistproperties
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import LegacyListPropertiesEditing from './legacylistproperties/legacylistpropertiesediting.js';
+import ListPropertiesUI from './listproperties/listpropertiesui.js';
+/**
+ * The legacy list properties feature.
+ *
+ * This is a "glue" plugin that loads the {@link module:list/legacylistproperties/legacylistpropertiesediting~LegacyListPropertiesEditing
+ * legacy list properties editing feature} and the
+ * {@link module:list/listproperties/listpropertiesui~ListPropertiesUI list properties UI feature}.
+ */
+export default class LegacyListProperties extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [LegacyListPropertiesEditing, ListPropertiesUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'LegacyListProperties';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/legacytodolist/legacychecktodolistcommand.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @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/legacytodolist/legacychecktodolistcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+import type { Element } from 'ckeditor5/src/engine.js';
+/**
+ * The check to-do command.
+ *
+ * The command is registered by the {@link module:list/legacytodolist/legacytodolistediting~LegacyTodoListEditing} as
+ * the `checkTodoList` editor command and it is also available via aliased `todoListCheck` name.
+ */
+export default class LegacyCheckTodoListCommand extends Command {
+    /**
+     * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
+     *
+     * @observable
+     * @readonly
+     */
+    value: boolean;
+    /**
+     * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
+     *
+     * @internal
+     */
+    _selectedElements: Array<Element>;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
+     */
+    refresh(): void;
+    /**
+     * Gets all to-do list items selected by the {@link module:engine/model/selection~Selection}.
+     */
+    private _getSelectedItems;
+    /**
+     * 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;
+}

package/src/legacytodolist/legacychecktodolistcommand.js

@@ -0,0 +1,76 @@
+/**
+ * @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/legacytodolist/legacychecktodolistcommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+const attributeKey = 'todoListChecked';
+/**
+ * The check to-do command.
+ *
+ * The command is registered by the {@link module:list/legacytodolist/legacytodolistediting~LegacyTodoListEditing} as
+ * the `checkTodoList` editor command and it is also available via aliased `todoListCheck` name.
+ */
+export default class LegacyCheckTodoListCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        this._selectedElements = [];
+        // 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() {
+        this._selectedElements = this._getSelectedItems();
+        this.value = this._selectedElements.every(element => !!element.getAttribute(attributeKey));
+        this.isEnabled = !!this._selectedElements.length;
+    }
+    /**
+     * 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, attributeKey)) {
+            elements.push(startElement);
+        }
+        for (const item of selectionRange.getItems()) {
+            if (schema.checkAttribute(item, attributeKey) && !elements.includes(item)) {
+                elements.push(item);
+            }
+        }
+        return elements;
+    }
+    /**
+     * 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 => {
+            for (const element of this._selectedElements) {
+                const value = (options.forceValue === undefined) ? !this.value : options.forceValue;
+                if (value) {
+                    writer.setAttribute(attributeKey, true, element);
+                }
+                else {
+                    writer.removeAttribute(attributeKey, element);
+                }
+            }
+        });
+    }
+}

package/src/legacytodolist/legacytodolistconverters.d.ts

@@ -0,0 +1,83 @@
+/**
+ * @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/legacytodolist/legacytodolistconverters
+ */
+import type { DowncastAttributeEvent, DowncastInsertEvent, Element, MapperModelToViewPositionEvent, Model, UpcastElementEvent, EditingView } from 'ckeditor5/src/engine.js';
+import { type GetCallback } from 'ckeditor5/src/utils.js';
+/**
+ * A model-to-view converter for the `listItem` model element insertion.
+ *
+ * It converts the `listItem` model element to an unordered list with a {@link module:engine/view/uielement~UIElement checkbox element}
+ * at the beginning of each list item. It also merges the list with surrounding lists (if available).
+ *
+ * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
+ * @param model Model instance.
+ * @param onCheckboxChecked Callback function.
+ * @returns Returns a conversion callback.
+ */
+export declare function modelViewInsertion(model: Model, onCheckboxChecked: (element: Element) => void): GetCallback<DowncastInsertEvent<Element>>;
+/**
+ * A model-to-view converter for the `listItem` model element insertion.
+ *
+ * It is used by {@link module:engine/controller/datacontroller~DataController}.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
+ * @param model Model instance.
+ * @returns Returns a conversion callback.
+ */
+export declare function dataModelViewInsertion(model: Model): GetCallback<DowncastInsertEvent<Element>>;
+/**
+ * A view-to-model converter for the checkbox element inside a view list item.
+ *
+ * It changes the `listType` of the model `listItem` to a `todo` value.
+ * When a view checkbox element is marked as checked, an additional `todoListChecked="true"` attribute is added to the model item.
+ *
+ * It is used by {@link module:engine/controller/datacontroller~DataController}.
+ *
+ * @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
+ */
+export declare const dataViewModelCheckmarkInsertion: GetCallback<UpcastElementEvent>;
+/**
+ * A model-to-view converter for the `listType` attribute change on the `listItem` model element.
+ *
+ * This change means that the `<li>` element parent changes to `<ul class="todo-list">` and a
+ * {@link module:engine/view/uielement~UIElement checkbox UI element} is added at the beginning
+ * of the list item element (or vice versa).
+ *
+ * This converter is preceded by {@link module:list/legacylist/legacyconverters~modelViewChangeType} and followed by
+ * {@link module:list/legacylist/legacyconverters~modelViewMergeAfterChangeType} to handle splitting and merging surrounding lists
+ * of the same type.
+ *
+ * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
+ * @param onCheckedChange Callback fired after clicking the checkbox UI element.
+ * @param view Editing view controller.
+ * @returns Returns a conversion callback.
+ */
+export declare function modelViewChangeType(onCheckedChange: (element: Element) => void, view: EditingView): GetCallback<DowncastAttributeEvent<Element>>;
+/**
+ * A model-to-view converter for the `todoListChecked` attribute change on the `listItem` model element.
+ *
+ * It marks the {@link module:engine/view/uielement~UIElement checkbox UI element} as checked.
+ *
+ * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
+ *
+ * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
+ * @param onCheckedChange Callback fired after clicking the checkbox UI element.
+ * @returns Returns a conversion callback.
+ */
+export declare function modelViewChangeChecked(onCheckedChange: (element: Element) => void): GetCallback<DowncastAttributeEvent<Element>>;
+/**
+ * A model-to-view position at zero offset mapper.
+ *
+ * This helper ensures that position inside todo-list in the view is mapped after the checkbox.
+ *
+ * It only handles the position at the beginning of a list item as other positions are properly mapped be the default mapper.
+ */
+export declare function mapModelToViewPosition(view: EditingView): GetCallback<MapperModelToViewPositionEvent>;