@ckeditor/ckeditor5-list 38.0.1 → 38.1.1

package/src/documentlist/utils/view.js

@@ -1,117 +1,117 @@
-/**
- * @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
- */
-/**
- * Checks if view element is a list type (ul or ol).
- *
- * @internal
- */
-export function isListView(viewElement) {
-    return viewElement.is('element', 'ol') || viewElement.is('element', 'ul');
-}
-/**
- * Checks if view element is a list item (li).
- *
- * @internal
- */
-export function isListItemView(viewElement) {
-    return viewElement.is('element', 'li');
-}
-/**
- * Calculates the indent value for a list item. Handles HTML compliant and non-compliant lists.
- *
- * Also, fixes non HTML compliant lists indents:
- *
- * ```
- * before:                                     fixed list:
- * OL                                          OL
- * |-> LI (parent LIs: 0)                      |-> LI     (indent: 0)
- *     |-> OL                                  |-> OL
- *         |-> OL                                  |
- *         |   |-> OL                              |
- *         |       |-> OL                          |
- *         |           |-> LI (parent LIs: 1)      |-> LI (indent: 1)
- *         |-> LI (parent LIs: 1)                  |-> LI (indent: 1)
- *
- * before:                                     fixed list:
- * OL                                          OL
- * |-> OL                                      |
- *     |-> OL                                  |
- *          |-> OL                             |
- *              |-> LI (parent LIs: 0)         |-> LI        (indent: 0)
- *
- * before:                                     fixed list:
- * OL                                          OL
- * |-> LI (parent LIs: 0)                      |-> LI         (indent: 0)
- * |-> OL                                          |-> OL
- *     |-> LI (parent LIs: 0)                          |-> LI (indent: 1)
- * ```
- *
- * @internal
- */
-export function getIndent(listItem) {
-    let indent = 0;
-    let parent = listItem.parent;
-    while (parent) {
-        // Each LI in the tree will result in an increased indent for HTML compliant lists.
-        if (isListItemView(parent)) {
-            indent++;
-        }
-        else {
-            // If however the list is nested in other list we should check previous sibling of any of the list elements...
-            const previousSibling = parent.previousSibling;
-            // ...because the we might need increase its indent:
-            //		before:                           fixed list:
-            //		OL                                OL
-            //		|-> LI (parent LIs: 0)            |-> LI         (indent: 0)
-            //		|-> OL                                |-> OL
-            //		    |-> LI (parent LIs: 0)                |-> LI (indent: 1)
-            if (previousSibling && isListItemView(previousSibling)) {
-                indent++;
-            }
-        }
-        parent = parent.parent;
-    }
-    return indent;
-}
-/**
- * Creates a list attribute element (ol or ul).
- *
- * @internal
- */
-export function createListElement(writer, indent, type, id = getViewElementIdForListType(type, indent)) {
-    // Negative priorities so that restricted editing attribute won't wrap lists.
-    return writer.createAttributeElement(getViewElementNameForListType(type), null, {
-        priority: 2 * indent / 100 - 100,
-        id
-    });
-}
-/**
- * Creates a list item attribute element (li).
- *
- * @internal
- */
-export function createListItemElement(writer, indent, id) {
-    // Negative priorities so that restricted editing attribute won't wrap list items.
-    return writer.createAttributeElement('li', null, {
-        priority: (2 * indent + 1) / 100 - 100,
-        id
-    });
-}
-/**
- * Returns a view element name for the given list type.
- *
- * @internal
- */
-export function getViewElementNameForListType(type) {
-    return type == 'numbered' ? 'ol' : 'ul';
-}
-/**
- * Returns a view element ID for the given list type and indent.
- *
- * @internal
- */
-export function getViewElementIdForListType(type, indent) {
-    return `list-${type}-${indent}`;
-}
+/**
+ * @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
+ */
+/**
+ * Checks if view element is a list type (ul or ol).
+ *
+ * @internal
+ */
+export function isListView(viewElement) {
+    return viewElement.is('element', 'ol') || viewElement.is('element', 'ul');
+}
+/**
+ * Checks if view element is a list item (li).
+ *
+ * @internal
+ */
+export function isListItemView(viewElement) {
+    return viewElement.is('element', 'li');
+}
+/**
+ * Calculates the indent value for a list item. Handles HTML compliant and non-compliant lists.
+ *
+ * Also, fixes non HTML compliant lists indents:
+ *
+ * ```
+ * before:                                     fixed list:
+ * OL                                          OL
+ * |-> LI (parent LIs: 0)                      |-> LI     (indent: 0)
+ *     |-> OL                                  |-> OL
+ *         |-> OL                                  |
+ *         |   |-> OL                              |
+ *         |       |-> OL                          |
+ *         |           |-> LI (parent LIs: 1)      |-> LI (indent: 1)
+ *         |-> LI (parent LIs: 1)                  |-> LI (indent: 1)
+ *
+ * before:                                     fixed list:
+ * OL                                          OL
+ * |-> OL                                      |
+ *     |-> OL                                  |
+ *          |-> OL                             |
+ *              |-> LI (parent LIs: 0)         |-> LI        (indent: 0)
+ *
+ * before:                                     fixed list:
+ * OL                                          OL
+ * |-> LI (parent LIs: 0)                      |-> LI         (indent: 0)
+ * |-> OL                                          |-> OL
+ *     |-> LI (parent LIs: 0)                          |-> LI (indent: 1)
+ * ```
+ *
+ * @internal
+ */
+export function getIndent(listItem) {
+    let indent = 0;
+    let parent = listItem.parent;
+    while (parent) {
+        // Each LI in the tree will result in an increased indent for HTML compliant lists.
+        if (isListItemView(parent)) {
+            indent++;
+        }
+        else {
+            // If however the list is nested in other list we should check previous sibling of any of the list elements...
+            const previousSibling = parent.previousSibling;
+            // ...because the we might need increase its indent:
+            //		before:                           fixed list:
+            //		OL                                OL
+            //		|-> LI (parent LIs: 0)            |-> LI         (indent: 0)
+            //		|-> OL                                |-> OL
+            //		    |-> LI (parent LIs: 0)                |-> LI (indent: 1)
+            if (previousSibling && isListItemView(previousSibling)) {
+                indent++;
+            }
+        }
+        parent = parent.parent;
+    }
+    return indent;
+}
+/**
+ * Creates a list attribute element (ol or ul).
+ *
+ * @internal
+ */
+export function createListElement(writer, indent, type, id = getViewElementIdForListType(type, indent)) {
+    // Negative priorities so that restricted editing attribute won't wrap lists.
+    return writer.createAttributeElement(getViewElementNameForListType(type), null, {
+        priority: 2 * indent / 100 - 100,
+        id
+    });
+}
+/**
+ * Creates a list item attribute element (li).
+ *
+ * @internal
+ */
+export function createListItemElement(writer, indent, id) {
+    // Negative priorities so that restricted editing attribute won't wrap list items.
+    return writer.createAttributeElement('li', null, {
+        priority: (2 * indent + 1) / 100 - 100,
+        id
+    });
+}
+/**
+ * Returns a view element name for the given list type.
+ *
+ * @internal
+ */
+export function getViewElementNameForListType(type) {
+    return type == 'numbered' ? 'ol' : 'ul';
+}
+/**
+ * Returns a view element ID for the given list type and indent.
+ *
+ * @internal
+ */
+export function getViewElementIdForListType(type, indent) {
+    return `list-${type}-${indent}`;
+}

package/src/documentlist.d.ts

@@ -1,26 +1,26 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlist
- */
-import { Plugin } from 'ckeditor5/src/core';
-import DocumentListEditing from './documentlist/documentlistediting';
-import ListUI from './list/listui';
-/**
- * The document list feature.
- *
- * This is a "glue" plugin that loads the {@link module:list/documentlist/documentlistediting~DocumentListEditing document list
- * editing feature} and {@link module:list/list/listui~ListUI list UI feature}.
- */
-export default class DocumentList extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof DocumentListEditing, typeof ListUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): 'DocumentList';
-}
+/**
+ * @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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import DocumentListEditing from './documentlist/documentlistediting';
+import ListUI from './list/listui';
+/**
+ * The document list feature.
+ *
+ * This is a "glue" plugin that loads the {@link module:list/documentlist/documentlistediting~DocumentListEditing document list
+ * editing feature} and {@link module:list/list/listui~ListUI list UI feature}.
+ */
+export default class DocumentList extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof DocumentListEditing, typeof ListUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "DocumentList";
+}

package/src/documentlist.js

@@ -1,30 +1,30 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlist
- */
-import { Plugin } from 'ckeditor5/src/core';
-import DocumentListEditing from './documentlist/documentlistediting';
-import ListUI from './list/listui';
-/**
- * The document list feature.
- *
- * This is a "glue" plugin that loads the {@link module:list/documentlist/documentlistediting~DocumentListEditing document list
- * editing feature} and {@link module:list/list/listui~ListUI list UI feature}.
- */
-export default class DocumentList extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DocumentListEditing, ListUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'DocumentList';
-    }
-}
+/**
+ * @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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import DocumentListEditing from './documentlist/documentlistediting';
+import ListUI from './list/listui';
+/**
+ * The document list feature.
+ *
+ * This is a "glue" plugin that loads the {@link module:list/documentlist/documentlistediting~DocumentListEditing document list
+ * editing feature} and {@link module:list/list/listui~ListUI list UI feature}.
+ */
+export default class DocumentList extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [DocumentListEditing, ListUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'DocumentList';
+    }
+}

package/src/documentlistproperties/converters.d.ts

@@ -1,19 +1,19 @@
-/**
- * @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/converters
- */
-import type { UpcastElementEvent } from 'ckeditor5/src/engine';
-import type { GetCallback } from 'ckeditor5/src/utils';
-import type { AttributeStrategy } from './documentlistpropertiesediting';
-/**
- * Returns a converter that consumes the `style`, `reversed`, and `start` attributes.
- * In `style`, it searches for the `list-style-type` definition.
- * If not found, the `"default"` value will be used.
- *
- * @internal
- * @param strategy
- */
-export declare function listPropertiesUpcastConverter(strategy: AttributeStrategy): GetCallback<UpcastElementEvent>;
+/**
+ * @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/converters
+ */
+import type { UpcastElementEvent } from 'ckeditor5/src/engine';
+import type { GetCallback } from 'ckeditor5/src/utils';
+import type { AttributeStrategy } from './documentlistpropertiesediting';
+/**
+ * Returns a converter that consumes the `style`, `reversed`, and `start` attributes.
+ * In `style`, it searches for the `list-style-type` definition.
+ * If not found, the `"default"` value will be used.
+ *
+ * @internal
+ * @param strategy
+ */
+export declare function listPropertiesUpcastConverter(strategy: AttributeStrategy): GetCallback<UpcastElementEvent>;

package/src/documentlistproperties/converters.js

@@ -1,43 +1,43 @@
-/**
- * @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
- */
-/**
- * Returns a converter that consumes the `style`, `reversed`, and `start` attributes.
- * In `style`, it searches for the `list-style-type` definition.
- * If not found, the `"default"` value will be used.
- *
- * @internal
- * @param strategy
- */
-export function listPropertiesUpcastConverter(strategy) {
-    return (evt, data, conversionApi) => {
-        const { writer, schema, consumable } = conversionApi;
-        // If there is no view consumable to consume, set the default attribute value to be able to reconvert nested lists on parent change.
-        // So abort converting if attribute was directly consumed.
-        if (consumable.test(data.viewItem, strategy.viewConsumables) === false) {
-            return;
-        }
-        if (!data.modelRange) {
-            Object.assign(data, conversionApi.convertChildren(data.viewItem, data.modelCursor));
-        }
-        let applied = false;
-        for (const item of data.modelRange.getItems({ shallow: true })) {
-            if (!schema.checkAttribute(item, strategy.attributeName)) {
-                continue;
-            }
-            if (!strategy.appliesToListItem(item)) {
-                continue;
-            }
-            // Set list attributes only on same level items, those nested deeper are already handled by the recursive conversion.
-            if (item.hasAttribute(strategy.attributeName)) {
-                continue;
-            }
-            writer.setAttribute(strategy.attributeName, strategy.getAttributeOnUpcast(data.viewItem), item);
-            applied = true;
-        }
-        if (applied) {
-            consumable.consume(data.viewItem, strategy.viewConsumables);
-        }
-    };
-}
+/**
+ * @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
+ */
+/**
+ * Returns a converter that consumes the `style`, `reversed`, and `start` attributes.
+ * In `style`, it searches for the `list-style-type` definition.
+ * If not found, the `"default"` value will be used.
+ *
+ * @internal
+ * @param strategy
+ */
+export function listPropertiesUpcastConverter(strategy) {
+    return (evt, data, conversionApi) => {
+        const { writer, schema, consumable } = conversionApi;
+        // If there is no view consumable to consume, set the default attribute value to be able to reconvert nested lists on parent change.
+        // So abort converting if attribute was directly consumed.
+        if (consumable.test(data.viewItem, strategy.viewConsumables) === false) {
+            return;
+        }
+        if (!data.modelRange) {
+            Object.assign(data, conversionApi.convertChildren(data.viewItem, data.modelCursor));
+        }
+        let applied = false;
+        for (const item of data.modelRange.getItems({ shallow: true })) {
+            if (!schema.checkAttribute(item, strategy.attributeName)) {
+                continue;
+            }
+            if (!strategy.appliesToListItem(item)) {
+                continue;
+            }
+            // Set list attributes only on same level items, those nested deeper are already handled by the recursive conversion.
+            if (item.hasAttribute(strategy.attributeName)) {
+                continue;
+            }
+            writer.setAttribute(strategy.attributeName, strategy.getAttributeOnUpcast(data.viewItem), item);
+            applied = true;
+        }
+        if (applied) {
+            consumable.consume(data.viewItem, strategy.viewConsumables);
+        }
+    };
+}

package/src/documentlistproperties/documentlistpropertiesediting.d.ts

@@ -1,88 +1,88 @@
-/**
- * @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;
-    }
-}
+/**
+ * @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;
+    }
+}