@ckeditor/ckeditor5-list 40.0.0 → 40.2.0

package/src/list/listediting.js

@@ -1,161 +1,161 @@
-/**
- * @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/list/listediting
- */
-import ListCommand from './listcommand';
-import IndentCommand from './indentcommand';
-import ListUtils from './listutils';
-import { Plugin } from 'ckeditor5/src/core';
-import { Enter } from 'ckeditor5/src/enter';
-import { Delete } from 'ckeditor5/src/typing';
-import { cleanList, cleanListItem, modelViewInsertion, modelViewChangeType, modelViewMergeAfterChangeType, modelViewMergeAfter, modelViewRemove, modelViewSplitOnInsert, modelViewChangeIndent, modelChangePostFixer, modelIndentPasteFixer, viewModelConverter, modelToViewPosition, viewToModelPosition } from './converters';
-import '../../theme/list.css';
-/**
- * The engine of the list feature. It handles creating, editing and removing lists and list items.
- *
- * It registers the `'numberedList'`, `'bulletedList'`, `'indentList'` and `'outdentList'` commands.
- */
-export default class ListEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ListEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [Enter, Delete, ListUtils];
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        // Schema.
-        // Note: in case `$block` will ever be allowed in `listItem`, keep in mind that this feature
-        // uses `Selection#getSelectedBlocks()` without any additional processing to obtain all selected list items.
-        // If there are blocks allowed inside list item, algorithms using `getSelectedBlocks()` will have to be modified.
-        editor.model.schema.register('listItem', {
-            inheritAllFrom: '$block',
-            allowAttributes: ['listType', 'listIndent']
-        });
-        // Converters.
-        const data = editor.data;
-        const editing = editor.editing;
-        editor.model.document.registerPostFixer(writer => modelChangePostFixer(editor.model, writer));
-        editing.mapper.registerViewToModelLength('li', getViewListItemLength);
-        data.mapper.registerViewToModelLength('li', getViewListItemLength);
-        editing.mapper.on('modelToViewPosition', modelToViewPosition(editing.view));
-        editing.mapper.on('viewToModelPosition', viewToModelPosition(editor.model));
-        data.mapper.on('modelToViewPosition', modelToViewPosition(editing.view));
-        editor.conversion.for('editingDowncast')
-            .add(dispatcher => {
-            dispatcher.on('insert', modelViewSplitOnInsert, { priority: 'high' });
-            dispatcher.on('insert:listItem', modelViewInsertion(editor.model));
-            dispatcher.on('attribute:listType:listItem', modelViewChangeType, { priority: 'high' });
-            dispatcher.on('attribute:listType:listItem', modelViewMergeAfterChangeType, { priority: 'low' });
-            dispatcher.on('attribute:listIndent:listItem', modelViewChangeIndent(editor.model));
-            dispatcher.on('remove:listItem', modelViewRemove(editor.model));
-            dispatcher.on('remove', modelViewMergeAfter, { priority: 'low' });
-        });
-        editor.conversion.for('dataDowncast')
-            .add(dispatcher => {
-            dispatcher.on('insert', modelViewSplitOnInsert, { priority: 'high' });
-            dispatcher.on('insert:listItem', modelViewInsertion(editor.model));
-        });
-        editor.conversion.for('upcast')
-            .add(dispatcher => {
-            dispatcher.on('element:ul', cleanList, { priority: 'high' });
-            dispatcher.on('element:ol', cleanList, { priority: 'high' });
-            dispatcher.on('element:li', cleanListItem, { priority: 'high' });
-            dispatcher.on('element:li', viewModelConverter);
-        });
-        // Fix indentation of pasted items.
-        editor.model.on('insertContent', modelIndentPasteFixer, { priority: 'high' });
-        // Register commands for numbered and bulleted list.
-        editor.commands.add('numberedList', new ListCommand(editor, 'numbered'));
-        editor.commands.add('bulletedList', new ListCommand(editor, 'bulleted'));
-        // Register commands for indenting.
-        editor.commands.add('indentList', new IndentCommand(editor, 'forward'));
-        editor.commands.add('outdentList', new IndentCommand(editor, 'backward'));
-        const viewDocument = editing.view.document;
-        // Overwrite default Enter key behavior.
-        // If Enter key is pressed with selection collapsed in empty list item, outdent it instead of breaking it.
-        this.listenTo(viewDocument, 'enter', (evt, data) => {
-            const doc = this.editor.model.document;
-            const positionParent = doc.selection.getLastPosition().parent;
-            if (doc.selection.isCollapsed && positionParent.name == 'listItem' && positionParent.isEmpty) {
-                this.editor.execute('outdentList');
-                data.preventDefault();
-                evt.stop();
-            }
-        }, { context: 'li' });
-        // Overwrite default Backspace key behavior.
-        // If Backspace key is pressed with selection collapsed on first position in first list item, outdent it. #83
-        this.listenTo(viewDocument, 'delete', (evt, data) => {
-            // Check conditions from those that require less computations like those immediately available.
-            if (data.direction !== 'backward') {
-                return;
-            }
-            const selection = this.editor.model.document.selection;
-            if (!selection.isCollapsed) {
-                return;
-            }
-            const firstPosition = selection.getFirstPosition();
-            if (!firstPosition.isAtStart) {
-                return;
-            }
-            const positionParent = firstPosition.parent;
-            if (positionParent.name !== 'listItem') {
-                return;
-            }
-            const previousIsAListItem = positionParent.previousSibling && positionParent.previousSibling.name === 'listItem';
-            if (previousIsAListItem) {
-                return;
-            }
-            this.editor.execute('outdentList');
-            data.preventDefault();
-            evt.stop();
-        }, { context: 'li' });
-        this.listenTo(editor.editing.view.document, 'tab', (evt, data) => {
-            const commandName = data.shiftKey ? 'outdentList' : 'indentList';
-            const command = this.editor.commands.get(commandName);
-            if (command.isEnabled) {
-                editor.execute(commandName);
-                data.stopPropagation();
-                data.preventDefault();
-                evt.stop();
-            }
-        }, { context: 'li' });
-    }
-    /**
-     * @inheritDoc
-     */
-    afterInit() {
-        const commands = this.editor.commands;
-        const indent = commands.get('indent');
-        const outdent = commands.get('outdent');
-        if (indent) {
-            indent.registerChildCommand(commands.get('indentList'));
-        }
-        if (outdent) {
-            outdent.registerChildCommand(commands.get('outdentList'));
-        }
-    }
-}
-function getViewListItemLength(element) {
-    let length = 1;
-    for (const child of element.getChildren()) {
-        if (child.name == 'ul' || child.name == 'ol') {
-            for (const item of child.getChildren()) {
-                length += getViewListItemLength(item);
-            }
-        }
-    }
-    return length;
-}
+/**
+ * @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/list/listediting
+ */
+import ListCommand from './listcommand';
+import IndentCommand from './indentcommand';
+import ListUtils from './listutils';
+import { Plugin } from 'ckeditor5/src/core';
+import { Enter } from 'ckeditor5/src/enter';
+import { Delete } from 'ckeditor5/src/typing';
+import { cleanList, cleanListItem, modelViewInsertion, modelViewChangeType, modelViewMergeAfterChangeType, modelViewMergeAfter, modelViewRemove, modelViewSplitOnInsert, modelViewChangeIndent, modelChangePostFixer, modelIndentPasteFixer, viewModelConverter, modelToViewPosition, viewToModelPosition } from './converters';
+import '../../theme/list.css';
+/**
+ * The engine of the list feature. It handles creating, editing and removing lists and list items.
+ *
+ * It registers the `'numberedList'`, `'bulletedList'`, `'indentList'` and `'outdentList'` commands.
+ */
+export default class ListEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ListEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [Enter, Delete, ListUtils];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        // Schema.
+        // Note: in case `$block` will ever be allowed in `listItem`, keep in mind that this feature
+        // uses `Selection#getSelectedBlocks()` without any additional processing to obtain all selected list items.
+        // If there are blocks allowed inside list item, algorithms using `getSelectedBlocks()` will have to be modified.
+        editor.model.schema.register('listItem', {
+            inheritAllFrom: '$block',
+            allowAttributes: ['listType', 'listIndent']
+        });
+        // Converters.
+        const data = editor.data;
+        const editing = editor.editing;
+        editor.model.document.registerPostFixer(writer => modelChangePostFixer(editor.model, writer));
+        editing.mapper.registerViewToModelLength('li', getViewListItemLength);
+        data.mapper.registerViewToModelLength('li', getViewListItemLength);
+        editing.mapper.on('modelToViewPosition', modelToViewPosition(editing.view));
+        editing.mapper.on('viewToModelPosition', viewToModelPosition(editor.model));
+        data.mapper.on('modelToViewPosition', modelToViewPosition(editing.view));
+        editor.conversion.for('editingDowncast')
+            .add(dispatcher => {
+            dispatcher.on('insert', modelViewSplitOnInsert, { priority: 'high' });
+            dispatcher.on('insert:listItem', modelViewInsertion(editor.model));
+            dispatcher.on('attribute:listType:listItem', modelViewChangeType, { priority: 'high' });
+            dispatcher.on('attribute:listType:listItem', modelViewMergeAfterChangeType, { priority: 'low' });
+            dispatcher.on('attribute:listIndent:listItem', modelViewChangeIndent(editor.model));
+            dispatcher.on('remove:listItem', modelViewRemove(editor.model));
+            dispatcher.on('remove', modelViewMergeAfter, { priority: 'low' });
+        });
+        editor.conversion.for('dataDowncast')
+            .add(dispatcher => {
+            dispatcher.on('insert', modelViewSplitOnInsert, { priority: 'high' });
+            dispatcher.on('insert:listItem', modelViewInsertion(editor.model));
+        });
+        editor.conversion.for('upcast')
+            .add(dispatcher => {
+            dispatcher.on('element:ul', cleanList, { priority: 'high' });
+            dispatcher.on('element:ol', cleanList, { priority: 'high' });
+            dispatcher.on('element:li', cleanListItem, { priority: 'high' });
+            dispatcher.on('element:li', viewModelConverter);
+        });
+        // Fix indentation of pasted items.
+        editor.model.on('insertContent', modelIndentPasteFixer, { priority: 'high' });
+        // Register commands for numbered and bulleted list.
+        editor.commands.add('numberedList', new ListCommand(editor, 'numbered'));
+        editor.commands.add('bulletedList', new ListCommand(editor, 'bulleted'));
+        // Register commands for indenting.
+        editor.commands.add('indentList', new IndentCommand(editor, 'forward'));
+        editor.commands.add('outdentList', new IndentCommand(editor, 'backward'));
+        const viewDocument = editing.view.document;
+        // Overwrite default Enter key behavior.
+        // If Enter key is pressed with selection collapsed in empty list item, outdent it instead of breaking it.
+        this.listenTo(viewDocument, 'enter', (evt, data) => {
+            const doc = this.editor.model.document;
+            const positionParent = doc.selection.getLastPosition().parent;
+            if (doc.selection.isCollapsed && positionParent.name == 'listItem' && positionParent.isEmpty) {
+                this.editor.execute('outdentList');
+                data.preventDefault();
+                evt.stop();
+            }
+        }, { context: 'li' });
+        // Overwrite default Backspace key behavior.
+        // If Backspace key is pressed with selection collapsed on first position in first list item, outdent it. #83
+        this.listenTo(viewDocument, 'delete', (evt, data) => {
+            // Check conditions from those that require less computations like those immediately available.
+            if (data.direction !== 'backward') {
+                return;
+            }
+            const selection = this.editor.model.document.selection;
+            if (!selection.isCollapsed) {
+                return;
+            }
+            const firstPosition = selection.getFirstPosition();
+            if (!firstPosition.isAtStart) {
+                return;
+            }
+            const positionParent = firstPosition.parent;
+            if (positionParent.name !== 'listItem') {
+                return;
+            }
+            const previousIsAListItem = positionParent.previousSibling && positionParent.previousSibling.name === 'listItem';
+            if (previousIsAListItem) {
+                return;
+            }
+            this.editor.execute('outdentList');
+            data.preventDefault();
+            evt.stop();
+        }, { context: 'li' });
+        this.listenTo(editor.editing.view.document, 'tab', (evt, data) => {
+            const commandName = data.shiftKey ? 'outdentList' : 'indentList';
+            const command = this.editor.commands.get(commandName);
+            if (command.isEnabled) {
+                editor.execute(commandName);
+                data.stopPropagation();
+                data.preventDefault();
+                evt.stop();
+            }
+        }, { context: 'li' });
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        const commands = this.editor.commands;
+        const indent = commands.get('indent');
+        const outdent = commands.get('outdent');
+        if (indent) {
+            indent.registerChildCommand(commands.get('indentList'));
+        }
+        if (outdent) {
+            outdent.registerChildCommand(commands.get('outdentList'));
+        }
+    }
+}
+function getViewListItemLength(element) {
+    let length = 1;
+    for (const child of element.getChildren()) {
+        if (child.name == 'ul' || child.name == 'ol') {
+            for (const item of child.getChildren()) {
+                length += getViewListItemLength(item);
+            }
+        }
+    }
+    return length;
+}

package/src/list/listui.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
- */
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * The list UI feature. It introduces the `'numberedList'` and `'bulletedList'` buttons that
- * allow to convert paragraphs to and from list items and indent or outdent them.
- */
-export default class ListUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}
+/**
+ * @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';
+/**
+ * The list UI feature. It introduces the `'numberedList'` and `'bulletedList'` buttons that
+ * allow to convert paragraphs to and from list items and indent or outdent them.
+ */
+export default class ListUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ListUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/list/listui.js

@@ -1,32 +1,32 @@
-/**
- * @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/list/listui
- */
-import { createUIComponent } from './utils';
-import numberedListIcon from '../../theme/icons/numberedlist.svg';
-import bulletedListIcon from '../../theme/icons/bulletedlist.svg';
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * The list UI feature. It introduces the `'numberedList'` and `'bulletedList'` buttons that
- * allow to convert paragraphs to and from list items and indent or outdent them.
- */
-export default class ListUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ListUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const t = this.editor.t;
-        // Create two buttons and link them with numberedList and bulletedList commands.
-        createUIComponent(this.editor, 'numberedList', t('Numbered List'), numberedListIcon);
-        createUIComponent(this.editor, 'bulletedList', t('Bulleted List'), bulletedListIcon);
-    }
-}
+/**
+ * @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/list/listui
+ */
+import { createUIComponent } from './utils';
+import numberedListIcon from '../../theme/icons/numberedlist.svg';
+import bulletedListIcon from '../../theme/icons/bulletedlist.svg';
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The list UI feature. It introduces the `'numberedList'` and `'bulletedList'` buttons that
+ * allow to convert paragraphs to and from list items and indent or outdent them.
+ */
+export default class ListUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ListUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const t = this.editor.t;
+        // Create two buttons and link them with numberedList and bulletedList commands.
+        createUIComponent(this.editor, 'numberedList', t('Numbered List'), numberedListIcon);
+        createUIComponent(this.editor, 'bulletedList', t('Bulleted List'), bulletedListIcon);
+    }
+}

package/src/list/listutils.d.ts

@@ -1,41 +1,41 @@
-/**
- * @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/list/listutils
- */
-import type { Element, Model, Position } from 'ckeditor5/src/engine';
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * A set of helpers related to document lists.
- */
-export default class ListUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ListUtils";
-    /**
-     * Checks whether the given list-style-type is supported by numbered or bulleted list.
-     */
-    getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;
-    /**
-     * Returns an array with all `listItem` elements in the model selection.
-     *
-     * It returns all the items even if only a part of the list is selected, including items that belong to nested lists.
-     * If no list is selected, it returns an empty array.
-     * The order of the elements is not specified.
-     */
-    getSelectedListItems(model: Model): Array<Element>;
-    /**
-     * Returns an array with all `listItem` elements that represent the same list.
-     *
-     * It means that values of `listIndent`, `listType`, `listStyle`, `listReversed` and `listStart` for all items are equal.
-     *
-     * Additionally, if the `position` is inside a list item, that list item will be returned as well.
-     *
-     * @param position Starting position.
-     * @param direction Walking direction.
-     */
-    getSiblingNodes(position: Position, direction: 'forward' | 'backward'): Array<Element>;
-}
+/**
+ * @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/list/listutils
+ */
+import type { Element, Model, Position } from 'ckeditor5/src/engine';
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * A set of helpers related to document lists.
+ */
+export default class ListUtils extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ListUtils";
+    /**
+     * Checks whether the given list-style-type is supported by numbered or bulleted list.
+     */
+    getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;
+    /**
+     * Returns an array with all `listItem` elements in the model selection.
+     *
+     * It returns all the items even if only a part of the list is selected, including items that belong to nested lists.
+     * If no list is selected, it returns an empty array.
+     * The order of the elements is not specified.
+     */
+    getSelectedListItems(model: Model): Array<Element>;
+    /**
+     * Returns an array with all `listItem` elements that represent the same list.
+     *
+     * It means that values of `listIndent`, `listType`, `listStyle`, `listReversed` and `listStart` for all items are equal.
+     *
+     * Additionally, if the `position` is inside a list item, that list item will be returned as well.
+     *
+     * @param position Starting position.
+     * @param direction Walking direction.
+     */
+    getSiblingNodes(position: Position, direction: 'forward' | 'backward'): Array<Element>;
+}

package/src/list/listutils.js

@@ -1,46 +1,46 @@
-/**
- * @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 { getListTypeFromListStyleType, getSelectedListItems, getSiblingNodes } from './utils';
-/**
- * A set of helpers related to document lists.
- */
-export default class ListUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ListUtils';
-    }
-    /**
-     * Checks whether the given list-style-type is supported by numbered or bulleted list.
-     */
-    getListTypeFromListStyleType(listStyleType) {
-        return getListTypeFromListStyleType(listStyleType);
-    }
-    /**
-     * Returns an array with all `listItem` elements in the model selection.
-     *
-     * It returns all the items even if only a part of the list is selected, including items that belong to nested lists.
-     * If no list is selected, it returns an empty array.
-     * The order of the elements is not specified.
-     */
-    getSelectedListItems(model) {
-        return getSelectedListItems(model);
-    }
-    /**
-     * Returns an array with all `listItem` elements that represent the same list.
-     *
-     * It means that values of `listIndent`, `listType`, `listStyle`, `listReversed` and `listStart` for all items are equal.
-     *
-     * Additionally, if the `position` is inside a list item, that list item will be returned as well.
-     *
-     * @param position Starting position.
-     * @param direction Walking direction.
-     */
-    getSiblingNodes(position, direction) {
-        return getSiblingNodes(position, direction);
-    }
-}
+/**
+ * @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 { getListTypeFromListStyleType, getSelectedListItems, getSiblingNodes } from './utils';
+/**
+ * A set of helpers related to document lists.
+ */
+export default class ListUtils extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ListUtils';
+    }
+    /**
+     * Checks whether the given list-style-type is supported by numbered or bulleted list.
+     */
+    getListTypeFromListStyleType(listStyleType) {
+        return getListTypeFromListStyleType(listStyleType);
+    }
+    /**
+     * Returns an array with all `listItem` elements in the model selection.
+     *
+     * It returns all the items even if only a part of the list is selected, including items that belong to nested lists.
+     * If no list is selected, it returns an empty array.
+     * The order of the elements is not specified.
+     */
+    getSelectedListItems(model) {
+        return getSelectedListItems(model);
+    }
+    /**
+     * Returns an array with all `listItem` elements that represent the same list.
+     *
+     * It means that values of `listIndent`, `listType`, `listStyle`, `listReversed` and `listStart` for all items are equal.
+     *
+     * Additionally, if the `position` is inside a list item, that list item will be returned as well.
+     *
+     * @param position Starting position.
+     * @param direction Walking direction.
+     */
+    getSiblingNodes(position, direction) {
+        return getSiblingNodes(position, direction);
+    }
+}