@ckeditor/ckeditor5-list 47.6.1 → 48.0.0-alpha.1

package/src/legacylistproperties/legacylistreversedcommand.js

@@ -1,52 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @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 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.js

@@ -1,52 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @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 class LegacyListStartCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const value = this._getValue();
-        this.value = value;
-        this.isEnabled = value != null;
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options Execute options.
-     * @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.js

@@ -1,105 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @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 class LegacyListStyleCommand extends Command {
-    /**
-     * The default type of the list style.
-     */
-    defaultType;
-    /**
-     * 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 options Additional options.
-     * @param options.type 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.js

@@ -1,37 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @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 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.js

@@ -1,82 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @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 class LegacyCheckTodoListCommand extends Command {
-    /**
-     * A list of to-do list items selected by the {@link module:engine/model/selection~ModelSelection}.
-     *
-     * @internal
-     */
-    _selectedElements;
-    /**
-     * @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~ModelSelection}.
-     */
-    _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.js

@@ -1,268 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { createElement } from 'ckeditor5/src/utils.js';
-import { generateLiInUl, injectViewList, positionAfterUiElements, findNestedList } from '../legacylist/legacyutils.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~ViewUIElement 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}.
- *
- * @internal
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
- * @param model Model instance.
- * @param onCheckboxChecked Callback function.
- * @returns Returns a conversion callback.
- */
-export function modelViewInsertion(model, onCheckboxChecked) {
-    return (evt, data, conversionApi) => {
-        const consumable = conversionApi.consumable;
-        if (!consumable.test(data.item, 'insert') ||
-            !consumable.test(data.item, 'attribute:listType') ||
-            !consumable.test(data.item, 'attribute:listIndent')) {
-            return;
-        }
-        if (data.item.getAttribute('listType') != 'todo') {
-            return;
-        }
-        const modelItem = data.item;
-        consumable.consume(modelItem, 'insert');
-        consumable.consume(modelItem, 'attribute:listType');
-        consumable.consume(modelItem, 'attribute:listIndent');
-        consumable.consume(modelItem, 'attribute:todoListChecked');
-        const viewWriter = conversionApi.writer;
-        const viewItem = generateLiInUl(modelItem, conversionApi);
-        const isChecked = !!modelItem.getAttribute('todoListChecked');
-        const checkmarkElement = createCheckmarkElement(modelItem, viewWriter, isChecked, onCheckboxChecked);
-        const span = viewWriter.createContainerElement('span', {
-            class: 'todo-list__label__description'
-        });
-        viewWriter.addClass('todo-list', viewItem.parent);
-        viewWriter.insert(viewWriter.createPositionAt(viewItem, 0), checkmarkElement);
-        viewWriter.insert(viewWriter.createPositionAfter(checkmarkElement), span);
-        injectViewList(modelItem, viewItem, conversionApi, model);
-    };
-}
-/**
- * A model-to-view converter for the `listItem` model element insertion.
- *
- * It is used by {@link module:engine/controller/datacontroller~DataController}.
- *
- * @internal
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert
- * @param model Model instance.
- * @returns Returns a conversion callback.
- */
-export function dataModelViewInsertion(model) {
-    return (evt, data, conversionApi) => {
-        const consumable = conversionApi.consumable;
-        if (!consumable.test(data.item, 'insert') ||
-            !consumable.test(data.item, 'attribute:listType') ||
-            !consumable.test(data.item, 'attribute:listIndent')) {
-            return;
-        }
-        if (data.item.getAttribute('listType') != 'todo') {
-            return;
-        }
-        const modelItem = data.item;
-        consumable.consume(modelItem, 'insert');
-        consumable.consume(modelItem, 'attribute:listType');
-        consumable.consume(modelItem, 'attribute:listIndent');
-        consumable.consume(modelItem, 'attribute:todoListChecked');
-        const viewWriter = conversionApi.writer;
-        const viewItem = generateLiInUl(modelItem, conversionApi);
-        viewWriter.addClass('todo-list', viewItem.parent);
-        const label = viewWriter.createContainerElement('label', {
-            class: 'todo-list__label'
-        });
-        const checkbox = viewWriter.createEmptyElement('input', {
-            type: 'checkbox',
-            disabled: 'disabled'
-        });
-        const span = viewWriter.createContainerElement('span', {
-            class: 'todo-list__label__description'
-        });
-        if (modelItem.getAttribute('todoListChecked')) {
-            viewWriter.setAttribute('checked', 'checked', checkbox);
-        }
-        viewWriter.insert(viewWriter.createPositionAt(viewItem, 0), label);
-        viewWriter.insert(viewWriter.createPositionAt(label, 0), checkbox);
-        viewWriter.insert(viewWriter.createPositionAfter(checkbox), span);
-        injectViewList(modelItem, viewItem, conversionApi, model);
-    };
-}
-/**
- * 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}.
- *
- * @internal
- * @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
- */
-export const dataViewModelCheckmarkInsertion = (evt, data, conversionApi) => {
-    const modelCursor = data.modelCursor;
-    const modelItem = modelCursor.parent;
-    const viewItem = data.viewItem;
-    if (viewItem.getAttribute('type') != 'checkbox' || modelItem.name != 'listItem' || !modelCursor.isAtStart) {
-        return;
-    }
-    if (!conversionApi.consumable.consume(viewItem, { name: true })) {
-        return;
-    }
-    const writer = conversionApi.writer;
-    writer.setAttribute('listType', 'todo', modelItem);
-    if (data.viewItem.hasAttribute('checked')) {
-        writer.setAttribute('todoListChecked', true, modelItem);
-    }
-    data.modelRange = writer.createRange(modelCursor);
-};
-/**
- * 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~ViewUIElement 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}.
- *
- * @internal
- * @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 function modelViewChangeType(onCheckedChange, view) {
-    return (evt, data, conversionApi) => {
-        if (!conversionApi.consumable.consume(data.item, evt.name)) {
-            return;
-        }
-        const viewItem = conversionApi.mapper.toViewElement(data.item);
-        const viewWriter = conversionApi.writer;
-        const labelElement = findLabel(viewItem, view);
-        if (data.attributeNewValue == 'todo') {
-            const isChecked = !!data.item.getAttribute('todoListChecked');
-            const checkmarkElement = createCheckmarkElement(data.item, viewWriter, isChecked, onCheckedChange);
-            const span = viewWriter.createContainerElement('span', {
-                class: 'todo-list__label__description'
-            });
-            const itemRange = viewWriter.createRangeIn(viewItem);
-            const nestedList = findNestedList(viewItem);
-            const descriptionStart = positionAfterUiElements(itemRange.start);
-            const descriptionEnd = nestedList ? viewWriter.createPositionBefore(nestedList) : itemRange.end;
-            const descriptionRange = viewWriter.createRange(descriptionStart, descriptionEnd);
-            viewWriter.addClass('todo-list', viewItem.parent);
-            viewWriter.move(descriptionRange, viewWriter.createPositionAt(span, 0));
-            viewWriter.insert(viewWriter.createPositionAt(viewItem, 0), checkmarkElement);
-            viewWriter.insert(viewWriter.createPositionAfter(checkmarkElement), span);
-        }
-        else if (data.attributeOldValue == 'todo') {
-            const descriptionSpan = findDescription(viewItem, view);
-            viewWriter.removeClass('todo-list', viewItem.parent);
-            viewWriter.remove(labelElement);
-            viewWriter.move(viewWriter.createRangeIn(descriptionSpan), viewWriter.createPositionBefore(descriptionSpan));
-            viewWriter.remove(descriptionSpan);
-        }
-    };
-}
-/**
- * A model-to-view converter for the `todoListChecked` attribute change on the `listItem` model element.
- *
- * It marks the {@link module:engine/view/uielement~ViewUIElement checkbox UI element} as checked.
- *
- * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
- *
- * @internal
- * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute
- * @param onCheckedChange Callback fired after clicking the checkbox UI element.
- * @returns Returns a conversion callback.
- */
-export function modelViewChangeChecked(onCheckedChange) {
-    return (evt, data, conversionApi) => {
-        // Do not convert `todoListChecked` attribute when to-do list item has changed to other list item.
-        // This attribute will be removed by the model post fixer.
-        if (data.item.getAttribute('listType') != 'todo') {
-            return;
-        }
-        if (!conversionApi.consumable.consume(data.item, 'attribute:todoListChecked')) {
-            return;
-        }
-        const { mapper, writer: viewWriter } = conversionApi;
-        const isChecked = !!data.item.getAttribute('todoListChecked');
-        const viewItem = mapper.toViewElement(data.item);
-        // Because of m -> v position mapper we can be sure checkbox is always at the beginning.
-        const oldCheckmarkElement = viewItem.getChild(0);
-        const newCheckmarkElement = createCheckmarkElement(data.item, viewWriter, isChecked, onCheckedChange);
-        viewWriter.insert(viewWriter.createPositionAfter(oldCheckmarkElement), newCheckmarkElement);
-        viewWriter.remove(oldCheckmarkElement);
-    };
-}
-/**
- * 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.
- *
- * @internal
- */
-export function mapModelToViewPosition(view) {
-    return (evt, data) => {
-        const modelPosition = data.modelPosition;
-        const parent = modelPosition.parent;
-        if (!parent.is('element', 'listItem') || parent.getAttribute('listType') != 'todo') {
-            return;
-        }
-        const viewLi = data.mapper.toViewElement(parent);
-        const descSpan = findDescription(viewLi, view);
-        if (descSpan) {
-            data.viewPosition = data.mapper.findPositionIn(descSpan, modelPosition.offset);
-        }
-    };
-}
-/**
- * Creates a checkbox UI element.
- */
-function createCheckmarkElement(modelItem, viewWriter, isChecked, onChange) {
-    const uiElement = viewWriter.createUIElement('label', {
-        class: 'todo-list__label',
-        contenteditable: false
-    }, function (domDocument) {
-        const checkbox = createElement(document, 'input', { type: 'checkbox', tabindex: '-1' });
-        if (isChecked) {
-            checkbox.setAttribute('checked', 'checked');
-        }
-        checkbox.addEventListener('change', () => onChange(modelItem));
-        const domElement = this.toDomElement(domDocument);
-        domElement.appendChild(checkbox);
-        return domElement;
-    });
-    return uiElement;
-}
-// Helper method to find label element inside li.
-function findLabel(viewItem, view) {
-    const range = view.createRangeIn(viewItem);
-    for (const value of range) {
-        if (value.item.is('uiElement', 'label')) {
-            return value.item;
-        }
-    }
-}
-function findDescription(viewItem, view) {
-    const range = view.createRangeIn(viewItem);
-    for (const value of range) {
-        if (value.item.is('containerElement', 'span') && value.item.hasClass('todo-list__label__description')) {
-            return value.item;
-        }
-    }
-}