@ckeditor/ckeditor5-list 39.0.1 → 40.0.0

package/src/documentlistproperties/documentlistpropertiesediting.js

@@ -1,289 +1,266 @@
-/**
- * @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('$container', { allowAttributes: strategy.attributeName });
-            model.schema.extend('$block', { allowAttributes: strategy.attributeName });
-            model.schema.extend('$blockObject', { 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 }) => {
-            const previousNodesByIndent = []; // Last seen nodes of lower indented lists.
-            for (const { node, previous } of listNodes) {
-                // For the first list block there is nothing to compare with.
-                if (!previous) {
-                    continue;
-                }
-                const nodeIndent = node.getAttribute('listIndent');
-                const previousNodeIndent = previous.getAttribute('listIndent');
-                let previousNodeInList = null; // It's like `previous` but has the same indent as current node.
-                // Let's find previous node for the same indent.
-                // We're going to need that when we get back to previous indent.
-                if (nodeIndent > previousNodeIndent) {
-                    previousNodesByIndent[previousNodeIndent] = previous;
-                }
-                // Restore the one for given indent.
-                else if (nodeIndent < previousNodeIndent) {
-                    previousNodeInList = previousNodesByIndent[nodeIndent];
-                    previousNodesByIndent.length = nodeIndent;
-                }
-                // Same indent.
-                else {
-                    previousNodeInList = previous;
-                }
-                // 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() {
-                return true;
-            },
-            hasValidAttribute(item) {
-                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;
-}
+/**
+ * @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/documentlistpropertiesutils.d.ts

@@ -1,33 +1,33 @@
-/**
- * @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/documentlistpropertiesutils
- */
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * A set of helpers related to document lists.
- */
-export default class DocumentListPropertiesUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "DocumentListPropertiesUtils";
-    /**
-     * Gets all the style types supported by given list type.
-     */
-    getAllSupportedStyleTypes(): Array<string>;
-    /**
-     * Checks whether the given list-style-type is supported by numbered or bulleted list.
-     */
-    getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;
-    /**
-     * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
-     */
-    getListStyleTypeFromTypeAttribute(value: string): string | null;
-    /**
-     * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
-     */
-    getTypeAttributeFromListStyleType(value: string): string | null;
-}
+/**
+ * @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/documentlistpropertiesutils
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * A set of helpers related to document lists.
+ */
+export default class DocumentListPropertiesUtils extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "DocumentListPropertiesUtils";
+    /**
+     * Gets all the style types supported by given list type.
+     */
+    getAllSupportedStyleTypes(): Array<string>;
+    /**
+     * Checks whether the given list-style-type is supported by numbered or bulleted list.
+     */
+    getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;
+    /**
+     * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
+     */
+    getListStyleTypeFromTypeAttribute(value: string): string | null;
+    /**
+     * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
+     */
+    getTypeAttributeFromListStyleType(value: string): string | null;
+}