@ckeditor/ckeditor5-list 40.2.0 → 41.1.0

package/src/documentlist/documentlistutils.d.ts

@@ -1,46 +0,0 @@
-/**
- * @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/documentlist/documentlistutils
- */
-import type { Element, Node } from 'ckeditor5/src/engine';
-import type { ArrayOrItem } from 'ckeditor5/src/utils';
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * A set of helpers related to document lists.
- */
-export default class DocumentListUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "DocumentListUtils";
-    /**
-     * Expands the given list of selected blocks to include all the items of the lists they're in.
-     *
-     * @param blocks The list of selected blocks.
-     */
-    expandListBlocksToCompleteList(blocks: ArrayOrItem<Element>): Array<Element>;
-    /**
-     * Check if the given block is the first in the list item.
-     *
-     * @param listBlock The list block element.
-     */
-    isFirstBlockOfListItem(listBlock: Element): boolean;
-    /**
-     * Returns true if the given model node is a list item block.
-     *
-     * @param node A model node.
-     */
-    isListItemBlock(node: Node): boolean;
-    /**
-     * Expands the given list of selected blocks to include the leading and tailing blocks of partially selected list items.
-     *
-     * @param blocks The list of selected blocks.
-     * @param options.withNested Whether should include nested list items.
-     */
-    expandListBlocksToCompleteItems(blocks: ArrayOrItem<Element>, options?: {
-        withNested?: boolean;
-    }): Array<Element>;
-}

package/src/documentlist/documentlistutils.js

@@ -1,50 +0,0 @@
-/**
- * @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
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { expandListBlocksToCompleteItems, expandListBlocksToCompleteList, isFirstBlockOfListItem, isListItemBlock } from './utils/model';
-/**
- * A set of helpers related to document lists.
- */
-export default class DocumentListUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'DocumentListUtils';
-    }
-    /**
-     * Expands the given list of selected blocks to include all the items of the lists they're in.
-     *
-     * @param blocks The list of selected blocks.
-     */
-    expandListBlocksToCompleteList(blocks) {
-        return expandListBlocksToCompleteList(blocks);
-    }
-    /**
-     * Check if the given block is the first in the list item.
-     *
-     * @param listBlock The list block element.
-     */
-    isFirstBlockOfListItem(listBlock) {
-        return isFirstBlockOfListItem(listBlock);
-    }
-    /**
-     * Returns true if the given model node is a list item block.
-     *
-     * @param node A model node.
-     */
-    isListItemBlock(node) {
-        return isListItemBlock(node);
-    }
-    /**
-     * Expands the given list of selected blocks to include the leading and tailing blocks of partially selected list items.
-     *
-     * @param blocks The list of selected blocks.
-     * @param options.withNested Whether should include nested list items.
-     */
-    expandListBlocksToCompleteItems(blocks, options = {}) {
-        return expandListBlocksToCompleteItems(blocks, options);
-    }
-}

package/src/documentlistproperties/documentlistpropertiesediting.d.ts

@@ -1,88 +0,0 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlistproperties/documentlistpropertiesediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-import type { Consumables, DowncastWriter, Element, Item, ViewElement } from 'ckeditor5/src/engine';
-import DocumentListEditing, { type ListItemAttributesMap } from '../documentlist/documentlistediting';
-import DocumentListPropertiesUtils from './documentlistpropertiesutils';
-/**
- * The document list properties engine feature.
- *
- * It registers the `'listStyle'`, `'listReversed'` and `'listStart'` commands if they are enabled in the configuration.
- * Read more in {@link module:list/listconfig~ListPropertiesConfig}.
- */
-export default class DocumentListPropertiesEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof DocumentListEditing, typeof DocumentListPropertiesUtils];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "DocumentListPropertiesEditing";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}
-/**
- * Strategy for dealing with `listItem` attributes supported by this plugin.
- *
- * @internal
- */
-export interface AttributeStrategy {
-    /**
-     * The model attribute name.
-     */
-    attributeName: keyof ListItemAttributesMap;
-    /**
-     * The model attribute default value.
-     */
-    defaultValue: unknown;
-    /**
-     * The view consumable as expected by {@link module:engine/conversion/viewconsumable~ViewConsumable#consume `ViewConsumable`}.
-     */
-    viewConsumables: Consumables;
-    /**
-     * Registers an editor command.
-     */
-    addCommand(editor: Editor): void;
-    /**
-     * Verifies whether the strategy is applicable for the specified model element.
-     */
-    appliesToListItem(element: Item): boolean;
-    /**
-     * Verifies whether the model attribute value is valid.
-     */
-    hasValidAttribute(element: Element): boolean;
-    /**
-     * Sets the property on the view element.
-     */
-    setAttributeOnDowncast(writer: DowncastWriter, value: unknown, element: ViewElement): void;
-    /**
-     * Retrieves the property value from the view element.
-     */
-    getAttributeOnUpcast(element: ViewElement): unknown;
-}
-declare module '../documentlist/documentlistediting' {
-    interface ListItemAttributesMap {
-        listStyle?: string;
-        listStart?: number;
-        listReversed?: boolean;
-    }
-}
-declare module '../documentlist/utils/model' {
-    interface ListElement {
-        getAttribute(key: 'listStyle'): string;
-        getAttribute(key: 'listStart'): number;
-        getAttribute(key: 'listReversed'): boolean;
-    }
-}

package/src/documentlistproperties/documentlistpropertiesediting.js

@@ -1,266 +0,0 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlistproperties/documentlistpropertiesediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import DocumentListEditing from '../documentlist/documentlistediting';
-import DocumentListStartCommand from './documentliststartcommand';
-import DocumentListStyleCommand from './documentliststylecommand';
-import DocumentListReversedCommand from './documentlistreversedcommand';
-import { listPropertiesUpcastConverter } from './converters';
-import { getAllSupportedStyleTypes, getListTypeFromListStyleType, getListStyleTypeFromTypeAttribute, getTypeAttributeFromListStyleType } from './utils/style';
-import DocumentListPropertiesUtils from './documentlistpropertiesutils';
-const DEFAULT_LIST_TYPE = 'default';
-/**
- * The document list properties engine feature.
- *
- * It registers the `'listStyle'`, `'listReversed'` and `'listStart'` commands if they are enabled in the configuration.
- * Read more in {@link module:list/listconfig~ListPropertiesConfig}.
- */
-export default class DocumentListPropertiesEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DocumentListEditing, DocumentListPropertiesUtils];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'DocumentListPropertiesEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        editor.config.define('list.properties', {
-            styles: true,
-            startIndex: false,
-            reversed: false
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const model = editor.model;
-        const documentListEditing = editor.plugins.get(DocumentListEditing);
-        const enabledProperties = editor.config.get('list.properties');
-        const strategies = createAttributeStrategies(enabledProperties);
-        for (const strategy of strategies) {
-            strategy.addCommand(editor);
-            model.schema.extend('$listItem', { allowAttributes: strategy.attributeName });
-            // Register downcast strategy.
-            documentListEditing.registerDowncastStrategy({
-                scope: 'list',
-                attributeName: strategy.attributeName,
-                setAttributeOnDowncast(writer, attributeValue, viewElement) {
-                    strategy.setAttributeOnDowncast(writer, attributeValue, viewElement);
-                }
-            });
-        }
-        // Set up conversion.
-        editor.conversion.for('upcast').add(dispatcher => {
-            for (const strategy of strategies) {
-                dispatcher.on('element:ol', listPropertiesUpcastConverter(strategy));
-                dispatcher.on('element:ul', listPropertiesUpcastConverter(strategy));
-            }
-        });
-        // Verify if the list view element (ul or ol) requires refreshing.
-        documentListEditing.on('checkAttributes:list', (evt, { viewElement, modelAttributes }) => {
-            for (const strategy of strategies) {
-                if (strategy.getAttributeOnUpcast(viewElement) != modelAttributes[strategy.attributeName]) {
-                    evt.return = true;
-                    evt.stop();
-                }
-            }
-        });
-        // Reset list properties after indenting list items.
-        this.listenTo(editor.commands.get('indentList'), 'afterExecute', (evt, changedBlocks) => {
-            model.change(writer => {
-                for (const node of changedBlocks) {
-                    for (const strategy of strategies) {
-                        if (strategy.appliesToListItem(node)) {
-                            // Just reset the attribute.
-                            // If there is a previous indented list that this node should be merged into,
-                            // the postfixer will unify all the attributes of both sub-lists.
-                            writer.setAttribute(strategy.attributeName, strategy.defaultValue, node);
-                        }
-                    }
-                }
-            });
-        });
-        // Add or remove list properties attributes depending on the list type.
-        documentListEditing.on('postFixer', (evt, { listNodes, writer }) => {
-            for (const { node } of listNodes) {
-                for (const strategy of strategies) {
-                    // Check if attribute is valid.
-                    if (strategy.hasValidAttribute(node)) {
-                        continue;
-                    }
-                    // Add missing default property attributes...
-                    if (strategy.appliesToListItem(node)) {
-                        writer.setAttribute(strategy.attributeName, strategy.defaultValue, node);
-                    }
-                    // ...or remove invalid property attributes.
-                    else {
-                        writer.removeAttribute(strategy.attributeName, node);
-                    }
-                    evt.return = true;
-                }
-            }
-        });
-        // Make sure that all items in a single list (items at the same level & listType) have the same properties.
-        documentListEditing.on('postFixer', (evt, { listNodes, writer }) => {
-            for (const { node, previousNodeInList } of listNodes) {
-                // This is a first item of a nested list.
-                if (!previousNodeInList) {
-                    continue;
-                }
-                // This is a first block of a list of a different type.
-                if (previousNodeInList.getAttribute('listType') != node.getAttribute('listType')) {
-                    continue;
-                }
-                // Copy properties from the previous one.
-                for (const strategy of strategies) {
-                    const { attributeName } = strategy;
-                    if (!strategy.appliesToListItem(node)) {
-                        continue;
-                    }
-                    const value = previousNodeInList.getAttribute(attributeName);
-                    if (node.getAttribute(attributeName) != value) {
-                        writer.setAttribute(attributeName, value, node);
-                        evt.return = true;
-                    }
-                }
-            }
-        });
-    }
-}
-/**
- * Creates an array of strategies for dealing with enabled listItem attributes.
- */
-function createAttributeStrategies(enabledProperties) {
-    const strategies = [];
-    if (enabledProperties.styles) {
-        const useAttribute = typeof enabledProperties.styles == 'object' && enabledProperties.styles.useAttribute;
-        strategies.push({
-            attributeName: 'listStyle',
-            defaultValue: DEFAULT_LIST_TYPE,
-            viewConsumables: { styles: 'list-style-type' },
-            addCommand(editor) {
-                let supportedTypes = getAllSupportedStyleTypes();
-                if (useAttribute) {
-                    supportedTypes = supportedTypes.filter(styleType => !!getTypeAttributeFromListStyleType(styleType));
-                }
-                editor.commands.add('listStyle', new DocumentListStyleCommand(editor, DEFAULT_LIST_TYPE, supportedTypes));
-            },
-            appliesToListItem(item) {
-                return item.getAttribute('listType') == 'numbered' || item.getAttribute('listType') == 'bulleted';
-            },
-            hasValidAttribute(item) {
-                if (!this.appliesToListItem(item)) {
-                    return !item.hasAttribute('listStyle');
-                }
-                if (!item.hasAttribute('listStyle')) {
-                    return false;
-                }
-                const value = item.getAttribute('listStyle');
-                if (value == DEFAULT_LIST_TYPE) {
-                    return true;
-                }
-                return getListTypeFromListStyleType(value) == item.getAttribute('listType');
-            },
-            setAttributeOnDowncast(writer, listStyle, element) {
-                if (listStyle && listStyle !== DEFAULT_LIST_TYPE) {
-                    if (useAttribute) {
-                        const value = getTypeAttributeFromListStyleType(listStyle);
-                        if (value) {
-                            writer.setAttribute('type', value, element);
-                            return;
-                        }
-                    }
-                    else {
-                        writer.setStyle('list-style-type', listStyle, element);
-                        return;
-                    }
-                }
-                writer.removeStyle('list-style-type', element);
-                writer.removeAttribute('type', element);
-            },
-            getAttributeOnUpcast(listParent) {
-                const style = listParent.getStyle('list-style-type');
-                if (style) {
-                    return style;
-                }
-                const attribute = listParent.getAttribute('type');
-                if (attribute) {
-                    return getListStyleTypeFromTypeAttribute(attribute);
-                }
-                return DEFAULT_LIST_TYPE;
-            }
-        });
-    }
-    if (enabledProperties.reversed) {
-        strategies.push({
-            attributeName: 'listReversed',
-            defaultValue: false,
-            viewConsumables: { attributes: 'reversed' },
-            addCommand(editor) {
-                editor.commands.add('listReversed', new DocumentListReversedCommand(editor));
-            },
-            appliesToListItem(item) {
-                return item.getAttribute('listType') == 'numbered';
-            },
-            hasValidAttribute(item) {
-                return this.appliesToListItem(item) == item.hasAttribute('listReversed');
-            },
-            setAttributeOnDowncast(writer, listReversed, element) {
-                if (listReversed) {
-                    writer.setAttribute('reversed', 'reversed', element);
-                }
-                else {
-                    writer.removeAttribute('reversed', element);
-                }
-            },
-            getAttributeOnUpcast(listParent) {
-                return listParent.hasAttribute('reversed');
-            }
-        });
-    }
-    if (enabledProperties.startIndex) {
-        strategies.push({
-            attributeName: 'listStart',
-            defaultValue: 1,
-            viewConsumables: { attributes: 'start' },
-            addCommand(editor) {
-                editor.commands.add('listStart', new DocumentListStartCommand(editor));
-            },
-            appliesToListItem(item) {
-                return item.getAttribute('listType') == 'numbered';
-            },
-            hasValidAttribute(item) {
-                return this.appliesToListItem(item) == item.hasAttribute('listStart');
-            },
-            setAttributeOnDowncast(writer, listStart, element) {
-                if (listStart == 0 || listStart > 1) {
-                    writer.setAttribute('start', listStart, element);
-                }
-                else {
-                    writer.removeAttribute('start', element);
-                }
-            },
-            getAttributeOnUpcast(listParent) {
-                const startAttributeValue = listParent.getAttribute('start');
-                return startAttributeValue >= 0 ? startAttributeValue : 1;
-            }
-        });
-    }
-    return strategies;
-}

package/src/documentlistproperties/documentlistreversedcommand.d.ts

@@ -1,36 +0,0 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlistproperties/documentlistreversedcommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The list reversed command. It changes the `listReversed` attribute of the selected list items,
- * letting the user to choose the order of an ordered list.
- * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- */
-export default class DocumentListReversedCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    value: boolean | null;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.reversed Whether the list should be reversed.
-     */
-    execute(options?: {
-        reversed?: boolean;
-    }): void;
-    /**
-     * Checks the command's {@link #value}.
-     */
-    private _getValue;
-}

package/src/documentlistproperties/documentlistreversedcommand.js

@@ -1,55 +0,0 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlistproperties/documentlistreversedcommand
- */
-import { Command } from 'ckeditor5/src/core';
-import { first } from 'ckeditor5/src/utils';
-import { expandListBlocksToCompleteList, isListItemBlock } from '../documentlist/utils/model';
-/**
- * The list reversed command. It changes the `listReversed` attribute of the selected list items,
- * letting the user to choose the order of an ordered list.
- * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- */
-export default class DocumentListReversedCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const value = this._getValue();
-        this.value = value;
-        this.isEnabled = value != null;
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.reversed Whether the list should be reversed.
-     */
-    execute(options = {}) {
-        const model = this.editor.model;
-        const document = model.document;
-        let blocks = Array.from(document.selection.getSelectedBlocks())
-            .filter(block => isListItemBlock(block) && block.getAttribute('listType') == 'numbered');
-        blocks = expandListBlocksToCompleteList(blocks);
-        model.change(writer => {
-            for (const block of blocks) {
-                writer.setAttribute('listReversed', !!options.reversed, block);
-            }
-        });
-    }
-    /**
-     * Checks the command's {@link #value}.
-     */
-    _getValue() {
-        const model = this.editor.model;
-        const document = model.document;
-        const block = first(document.selection.getSelectedBlocks());
-        if (isListItemBlock(block) && block.getAttribute('listType') == 'numbered') {
-            return block.getAttribute('listReversed');
-        }
-        return null;
-    }
-}

package/src/documentlistproperties/documentliststartcommand.js

@@ -1,57 +0,0 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlistproperties/documentliststartcommand
- */
-import { Command } from 'ckeditor5/src/core';
-import { first } from 'ckeditor5/src/utils';
-import { expandListBlocksToCompleteList, isListItemBlock } from '../documentlist/utils/model';
-/**
- * The list start index command. It changes the `listStart` attribute of the selected list items,
- * letting the user to choose the starting point of an ordered list.
- * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- */
-export default class DocumentListStartCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const value = this._getValue();
-        this.value = value;
-        this.isEnabled = value != null;
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.startIndex The list start index.
-     */
-    execute({ startIndex = 1 } = {}) {
-        const model = this.editor.model;
-        const document = model.document;
-        let blocks = Array.from(document.selection.getSelectedBlocks())
-            .filter(block => isListItemBlock(block) && block.getAttribute('listType') == 'numbered');
-        blocks = expandListBlocksToCompleteList(blocks);
-        model.change(writer => {
-            for (const block of blocks) {
-                writer.setAttribute('listStart', startIndex >= 0 ? startIndex : 1, block);
-            }
-        });
-    }
-    /**
-     * Checks the command's {@link #value}.
-     *
-     * @returns The current value.
-     */
-    _getValue() {
-        const model = this.editor.model;
-        const document = model.document;
-        const block = first(document.selection.getSelectedBlocks());
-        if (block && isListItemBlock(block) && block.getAttribute('listType') == 'numbered') {
-            return block.getAttribute('listStart');
-        }
-        return null;
-    }
-}

package/src/liststyle.d.ts

@@ -1,28 +0,0 @@
-/**
- * @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 +0,0 @@
-/**
- * @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.');
-    }
-}