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

package/src/list/listcommand.js

@@ -1,176 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { Command } from 'ckeditor5/src/core.js';
-import { splitListItemBefore, expandListBlocksToCompleteItems, getListItemBlocks, getListItems, removeListAttributes, outdentFollowingItems, ListItemUid, sortBlocks, getSelectedBlockObject, isListItemBlock, canBecomeSimpleListItem } from './utils/model.js';
-/**
- * The list command. It is used by the {@link module:list/list~List list feature}.
- */
-export class ListCommand extends Command {
-    /**
-     * The type of the list created by the command.
-     */
-    type;
-    /**
-     * List Walker options that change the range of the list items to be changed when the selection is collapsed within a list item.
-     *
-     * In a multi-level list, when the selection is collapsed within a list item, instead of changing only the list items of the same list
-     * type and current indent level, the entire list structure is changed (all list items at all indent levels of any list type).
-     */
-    _listWalkerOptions;
-    /**
-     * Creates an instance of the command.
-     *
-     * @param editor The editor instance.
-     * @param type List type that will be handled by this command.
-     */
-    constructor(editor, type, options = {}) {
-        super(editor);
-        this.type = type;
-        this._listWalkerOptions = options.multiLevel ? {
-            higherIndent: true,
-            lowerIndent: true,
-            sameAttributes: []
-        } : undefined;
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        this.value = this._getValue();
-        this.isEnabled = this._checkEnabled();
-    }
-    /**
-     * Executes the list command.
-     *
-     * @fires execute
-     * @fires afterExecute
-     * @param options Command options.
-     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will try to convert the
-     * selected items and potentially the neighbor elements to the proper list items. If set to `false` it will convert selected elements
-     * to paragraphs. If not set, the command will toggle selected elements to list items or paragraphs, depending on the selection.
-     * @param options.additionalAttributes Additional attributes that are set for list items when the command is executed.
-     */
-    execute(options = {}) {
-        const model = this.editor.model;
-        const document = model.document;
-        const selectedBlockObject = getSelectedBlockObject(model);
-        const blocks = Array.from(document.selection.getSelectedBlocks())
-            .filter(block => model.schema.checkAttribute(block, 'listType') || canBecomeSimpleListItem(block, model.schema));
-        // Whether we are turning off some items.
-        const turnOff = options.forceValue !== undefined ? !options.forceValue : this.value;
-        model.change(writer => {
-            if (turnOff) {
-                const lastBlock = blocks[blocks.length - 1];
-                const listEditing = this.editor.plugins.get('ListEditing');
-                const attributeNames = listEditing.getListAttributeNames();
-                // Split the first block from the list item.
-                const itemBlocks = getListItemBlocks(lastBlock, { direction: 'forward' });
-                const changedBlocks = [];
-                if (itemBlocks.length > 1) {
-                    changedBlocks.push(...splitListItemBefore(itemBlocks[1], writer));
-                }
-                // Strip list attributes.
-                changedBlocks.push(...removeListAttributes(blocks, writer, attributeNames));
-                // Outdent items following the selected list item.
-                changedBlocks.push(...outdentFollowingItems(lastBlock, writer));
-                this._fireAfterExecute(changedBlocks);
-            }
-            // Changing type of list items for a collapsed selection inside a list item.
-            else if ((selectedBlockObject || document.selection.isCollapsed) && isListItemBlock(blocks[0])) {
-                const changedBlocks = getListItems(selectedBlockObject || blocks[0], this._listWalkerOptions);
-                for (const block of changedBlocks) {
-                    writer.setAttributes({
-                        ...options.additionalAttributes,
-                        listType: this.type
-                    }, block);
-                }
-                this._fireAfterExecute(changedBlocks);
-            }
-            // Turning on the list items for a non-collapsed selection.
-            else {
-                const changedBlocks = [];
-                for (const block of blocks) {
-                    // Promote the given block to the list item.
-                    if (!block.hasAttribute('listType')) {
-                        // Rename block to a simple list item if this option is enabled.
-                        if (!block.is('element', 'listItem') && canBecomeSimpleListItem(block, model.schema)) {
-                            writer.rename(block, 'listItem');
-                        }
-                        writer.setAttributes({
-                            ...options.additionalAttributes,
-                            listIndent: 0,
-                            listItemId: ListItemUid.next(),
-                            listType: this.type
-                        }, block);
-                        changedBlocks.push(block);
-                    }
-                    // Change the type of list item.
-                    else {
-                        for (const node of expandListBlocksToCompleteItems(block, { withNested: false })) {
-                            if (node.getAttribute('listType') != this.type) {
-                                writer.setAttributes({
-                                    ...options.additionalAttributes,
-                                    listType: this.type
-                                }, node);
-                                changedBlocks.push(node);
-                            }
-                        }
-                    }
-                }
-                this._fireAfterExecute(changedBlocks);
-            }
-        });
-    }
-    /**
-     * Fires the `afterExecute` event.
-     *
-     * @param changedBlocks The changed list elements.
-     */
-    _fireAfterExecute(changedBlocks) {
-        this.fire('afterExecute', sortBlocks(new Set(changedBlocks)));
-    }
-    /**
-     * Checks the command's {@link #value}.
-     *
-     * @returns The current value.
-     */
-    _getValue() {
-        const selection = this.editor.model.document.selection;
-        const blocks = Array.from(selection.getSelectedBlocks());
-        if (!blocks.length) {
-            return false;
-        }
-        for (const block of blocks) {
-            if (block.getAttribute('listType') != this.type) {
-                return false;
-            }
-        }
-        return true;
-    }
-    /**
-     * Checks whether the command can be enabled in the current context.
-     *
-     * @returns Whether the command should be enabled.
-     */
-    _checkEnabled() {
-        const model = this.editor.model;
-        const schema = model.schema;
-        const selection = model.document.selection;
-        const blocks = Array.from(selection.getSelectedBlocks());
-        if (!blocks.length) {
-            return false;
-        }
-        // If command value is true it means that we are in list item, so the command should be enabled.
-        if (this.value) {
-            return true;
-        }
-        for (const block of blocks) {
-            if (schema.checkAttribute(block, 'listType') || canBecomeSimpleListItem(block, schema)) {
-                return true;
-            }
-        }
-        return false;
-    }
-}