@ckeditor/ckeditor5-indent 39.0.1 → 40.0.0

package/src/indentblock.js

@@ -1,142 +1,147 @@
-/**
- * @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 indent/indentblock
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { addMarginRules } from 'ckeditor5/src/engine';
-import IndentBlockCommand from './indentblockcommand';
-import IndentUsingOffset from './indentcommandbehavior/indentusingoffset';
-import IndentUsingClasses from './indentcommandbehavior/indentusingclasses';
-const DEFAULT_ELEMENTS = ['paragraph', 'heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6'];
-/**
- * The block indentation feature.
- *
- * It registers the `'indentBlock'` and `'outdentBlock'` commands.
- *
- * If the plugin {@link module:indent/indent~Indent} is defined, it also attaches the `'indentBlock'` and `'outdentBlock'` commands to
- * the `'indent'` and `'outdent'` commands.
- */
-export default class IndentBlock extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        editor.config.define('indentBlock', {
-            offset: 40,
-            unit: 'px'
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'IndentBlock';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const configuration = editor.config.get('indentBlock');
-        if (configuration.classes && configuration.classes.length) {
-            this._setupConversionUsingClasses(configuration.classes);
-            editor.commands.add('indentBlock', new IndentBlockCommand(editor, new IndentUsingClasses({
-                direction: 'forward',
-                classes: configuration.classes
-            })));
-            editor.commands.add('outdentBlock', new IndentBlockCommand(editor, new IndentUsingClasses({
-                direction: 'backward',
-                classes: configuration.classes
-            })));
-        }
-        else {
-            editor.data.addStyleProcessorRules(addMarginRules);
-            this._setupConversionUsingOffset();
-            editor.commands.add('indentBlock', new IndentBlockCommand(editor, new IndentUsingOffset({
-                direction: 'forward',
-                offset: configuration.offset,
-                unit: configuration.unit
-            })));
-            editor.commands.add('outdentBlock', new IndentBlockCommand(editor, new IndentUsingOffset({
-                direction: 'backward',
-                offset: configuration.offset,
-                unit: configuration.unit
-            })));
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    afterInit() {
-        const editor = this.editor;
-        const schema = editor.model.schema;
-        const indentCommand = editor.commands.get('indent');
-        const outdentCommand = editor.commands.get('outdent');
-        // Enable block indentation to heading configuration options. If it is not defined enable in paragraph and default headings.
-        const options = editor.config.get('heading.options');
-        const configuredElements = options && options.map(option => option.model);
-        const knownElements = configuredElements || DEFAULT_ELEMENTS;
-        knownElements.forEach(elementName => {
-            if (schema.isRegistered(elementName)) {
-                schema.extend(elementName, { allowAttributes: 'blockIndent' });
-            }
-        });
-        schema.setAttributeProperties('blockIndent', { isFormatting: true });
-        indentCommand.registerChildCommand(editor.commands.get('indentBlock'));
-        outdentCommand.registerChildCommand(editor.commands.get('outdentBlock'));
-    }
-    /**
-     * Setups conversion for using offset indents.
-     */
-    _setupConversionUsingOffset() {
-        const conversion = this.editor.conversion;
-        const locale = this.editor.locale;
-        const marginProperty = locale.contentLanguageDirection === 'rtl' ? 'margin-right' : 'margin-left';
-        conversion.for('upcast').attributeToAttribute({
-            view: {
-                styles: {
-                    [marginProperty]: /[\s\S]+/
-                }
-            },
-            model: {
-                key: 'blockIndent',
-                value: (viewElement) => viewElement.getStyle(marginProperty)
-            }
-        });
-        conversion.for('downcast').attributeToAttribute({
-            model: 'blockIndent',
-            view: modelAttributeValue => {
-                return {
-                    key: 'style',
-                    value: {
-                        [marginProperty]: modelAttributeValue
-                    }
-                };
-            }
-        });
-    }
-    /**
-     * Setups conversion for using classes.
-     */
-    _setupConversionUsingClasses(classes) {
-        const definition = {
-            model: {
-                key: 'blockIndent',
-                values: []
-            },
-            view: {}
-        };
-        for (const className of classes) {
-            definition.model.values.push(className);
-            definition.view[className] = {
-                key: 'class',
-                value: [className]
-            };
-        }
-        this.editor.conversion.attributeToAttribute(definition);
-    }
-}
+/**
+ * @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 indent/indentblock
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { addMarginRules } from 'ckeditor5/src/engine';
+import IndentBlockCommand from './indentblockcommand';
+import IndentUsingOffset from './indentcommandbehavior/indentusingoffset';
+import IndentUsingClasses from './indentcommandbehavior/indentusingclasses';
+const DEFAULT_ELEMENTS = ['paragraph', 'heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6'];
+/**
+ * The block indentation feature.
+ *
+ * It registers the `'indentBlock'` and `'outdentBlock'` commands.
+ *
+ * If the plugin {@link module:indent/indent~Indent} is defined, it also attaches the `'indentBlock'` and `'outdentBlock'` commands to
+ * the `'indent'` and `'outdent'` commands.
+ */
+export default class IndentBlock extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        editor.config.define('indentBlock', {
+            offset: 40,
+            unit: 'px'
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'IndentBlock';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const configuration = editor.config.get('indentBlock');
+        if (configuration.classes && configuration.classes.length) {
+            this._setupConversionUsingClasses(configuration.classes);
+            editor.commands.add('indentBlock', new IndentBlockCommand(editor, new IndentUsingClasses({
+                direction: 'forward',
+                classes: configuration.classes
+            })));
+            editor.commands.add('outdentBlock', new IndentBlockCommand(editor, new IndentUsingClasses({
+                direction: 'backward',
+                classes: configuration.classes
+            })));
+        }
+        else {
+            editor.data.addStyleProcessorRules(addMarginRules);
+            this._setupConversionUsingOffset();
+            editor.commands.add('indentBlock', new IndentBlockCommand(editor, new IndentUsingOffset({
+                direction: 'forward',
+                offset: configuration.offset,
+                unit: configuration.unit
+            })));
+            editor.commands.add('outdentBlock', new IndentBlockCommand(editor, new IndentUsingOffset({
+                direction: 'backward',
+                offset: configuration.offset,
+                unit: configuration.unit
+            })));
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        const editor = this.editor;
+        const schema = editor.model.schema;
+        const indentCommand = editor.commands.get('indent');
+        const outdentCommand = editor.commands.get('outdent');
+        // Enable block indentation to heading configuration options. If it is not defined enable in paragraph and default headings.
+        const options = editor.config.get('heading.options');
+        const configuredElements = options && options.map(option => option.model);
+        const knownElements = configuredElements || DEFAULT_ELEMENTS;
+        knownElements.forEach(elementName => {
+            if (schema.isRegistered(elementName)) {
+                schema.extend(elementName, { allowAttributes: 'blockIndent' });
+            }
+        });
+        schema.setAttributeProperties('blockIndent', { isFormatting: true });
+        indentCommand.registerChildCommand(editor.commands.get('indentBlock'));
+        outdentCommand.registerChildCommand(editor.commands.get('outdentBlock'));
+    }
+    /**
+     * Setups conversion for using offset indents.
+     */
+    _setupConversionUsingOffset() {
+        const conversion = this.editor.conversion;
+        const locale = this.editor.locale;
+        const marginProperty = locale.contentLanguageDirection === 'rtl' ? 'margin-right' : 'margin-left';
+        conversion.for('upcast').attributeToAttribute({
+            view: {
+                styles: {
+                    [marginProperty]: /[\s\S]+/
+                }
+            },
+            model: {
+                key: 'blockIndent',
+                value: (viewElement) => {
+                    // Do not indent block elements in Document Lists. See https://github.com/ckeditor/ckeditor5/issues/12466.
+                    if (!viewElement.is('element', 'li')) {
+                        return viewElement.getStyle(marginProperty);
+                    }
+                }
+            }
+        });
+        conversion.for('downcast').attributeToAttribute({
+            model: 'blockIndent',
+            view: modelAttributeValue => {
+                return {
+                    key: 'style',
+                    value: {
+                        [marginProperty]: modelAttributeValue
+                    }
+                };
+            }
+        });
+    }
+    /**
+     * Setups conversion for using classes.
+     */
+    _setupConversionUsingClasses(classes) {
+        const definition = {
+            model: {
+                key: 'blockIndent',
+                values: []
+            },
+            view: {}
+        };
+        for (const className of classes) {
+            definition.model.values.push(className);
+            definition.view[className] = {
+                key: 'class',
+                value: [className]
+            };
+        }
+        this.editor.conversion.attributeToAttribute(definition);
+    }
+}

package/src/indentblockcommand.d.ts

@@ -1,45 +1,56 @@
-/**
- * @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 indent/indentblockcommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core';
-import type { IndentBehavior } from './indentcommandbehavior/indentbehavior';
-/**
- * The indent block command.
- *
- * The command is registered by the {@link module:indent/indentblock~IndentBlock} as `'indentBlock'` for indenting blocks and
- * `'outdentBlock'` for outdenting blocks.
- *
- * To increase block indentation at the current selection, execute the command:
- *
- * ```ts
- * editor.execute( 'indentBlock' );
- * ```
- *
- * To decrease block indentation at the current selection, execute the command:
- *
- * ```ts
- * editor.execute( 'outdentBlock' );
- * ```
- */
-export default class IndentBlockCommand extends Command {
-    /**
-     * The command's indentation behavior.
-     */
-    private readonly _indentBehavior;
-    /**
-     * Creates an instance of the command.
-     */
-    constructor(editor: Editor, indentBehavior: IndentBehavior);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * @inheritDoc
-     */
-    execute(): 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
+ */
+/**
+ * @module indent/indentblockcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+import type { IndentBehavior } from './indentcommandbehavior/indentbehavior';
+/**
+ * The indent block command.
+ *
+ * The command is registered by the {@link module:indent/indentblock~IndentBlock} as `'indentBlock'` for indenting blocks and
+ * `'outdentBlock'` for outdenting blocks.
+ *
+ * To increase block indentation at the current selection, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'indentBlock' );
+ * ```
+ *
+ * To decrease block indentation at the current selection, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'outdentBlock' );
+ * ```
+ */
+export default class IndentBlockCommand extends Command {
+    /**
+     * The command's indentation behavior.
+     */
+    private readonly _indentBehavior;
+    /**
+     * Creates an instance of the command.
+     */
+    constructor(editor: Editor, indentBehavior: IndentBehavior);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * @inheritDoc
+     */
+    execute(): void;
+    /**
+     * Returns blocks from selection that should have blockIndent selection set.
+     */
+    private _getBlocksToChange;
+    /**
+     * Returns false if indentation cannot be applied, i.e.:
+     * - for blocks disallowed by schema declaration
+     * - for blocks in Document Lists (disallowed forward indentation only). See https://github.com/ckeditor/ckeditor5/issues/14155.
+     * Otherwise returns true.
+     */
+    private _isIndentationChangeAllowed;
+}

package/src/indentblockcommand.js

@@ -1,78 +1,98 @@
-/**
- * @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 indent/indentblockcommand
- */
-import { Command } from 'ckeditor5/src/core';
-import { first } from 'ckeditor5/src/utils';
-/**
- * The indent block command.
- *
- * The command is registered by the {@link module:indent/indentblock~IndentBlock} as `'indentBlock'` for indenting blocks and
- * `'outdentBlock'` for outdenting blocks.
- *
- * To increase block indentation at the current selection, execute the command:
- *
- * ```ts
- * editor.execute( 'indentBlock' );
- * ```
- *
- * To decrease block indentation at the current selection, execute the command:
- *
- * ```ts
- * editor.execute( 'outdentBlock' );
- * ```
- */
-export default class IndentBlockCommand extends Command {
-    /**
-     * Creates an instance of the command.
-     */
-    constructor(editor, indentBehavior) {
-        super(editor);
-        this._indentBehavior = indentBehavior;
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        // Check whether any of the position's ancestors is a list item.
-        const editor = this.editor;
-        const model = editor.model;
-        const block = first(model.document.selection.getSelectedBlocks());
-        if (!block || !model.schema.checkAttribute(block, 'blockIndent')) {
-            this.isEnabled = false;
-            return;
-        }
-        this.isEnabled = this._indentBehavior.checkEnabled(block.getAttribute('blockIndent'));
-    }
-    /**
-     * @inheritDoc
-     */
-    execute() {
-        const model = this.editor.model;
-        const blocksToChange = getBlocksToChange(model);
-        model.change(writer => {
-            for (const block of blocksToChange) {
-                const currentIndent = block.getAttribute('blockIndent');
-                const nextIndent = this._indentBehavior.getNextIndent(currentIndent);
-                if (nextIndent) {
-                    writer.setAttribute('blockIndent', nextIndent, block);
-                }
-                else {
-                    writer.removeAttribute('blockIndent', block);
-                }
-            }
-        });
-    }
-}
-/**
- * Returns blocks from selection that should have blockIndent selection set.
- */
-function getBlocksToChange(model) {
-    const selection = model.document.selection;
-    const schema = model.schema;
-    const blocksInSelection = Array.from(selection.getSelectedBlocks());
-    return blocksInSelection.filter(block => schema.checkAttribute(block, 'blockIndent'));
-}
+/**
+ * @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 indent/indentblockcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+import { first } from 'ckeditor5/src/utils';
+/**
+ * The indent block command.
+ *
+ * The command is registered by the {@link module:indent/indentblock~IndentBlock} as `'indentBlock'` for indenting blocks and
+ * `'outdentBlock'` for outdenting blocks.
+ *
+ * To increase block indentation at the current selection, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'indentBlock' );
+ * ```
+ *
+ * To decrease block indentation at the current selection, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'outdentBlock' );
+ * ```
+ */
+export default class IndentBlockCommand extends Command {
+    /**
+     * Creates an instance of the command.
+     */
+    constructor(editor, indentBehavior) {
+        super(editor);
+        this._indentBehavior = indentBehavior;
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const editor = this.editor;
+        const model = editor.model;
+        const block = first(model.document.selection.getSelectedBlocks());
+        if (!block || !this._isIndentationChangeAllowed(block)) {
+            this.isEnabled = false;
+            return;
+        }
+        this.isEnabled = this._indentBehavior.checkEnabled(block.getAttribute('blockIndent'));
+    }
+    /**
+     * @inheritDoc
+     */
+    execute() {
+        const model = this.editor.model;
+        const blocksToChange = this._getBlocksToChange();
+        model.change(writer => {
+            for (const block of blocksToChange) {
+                const currentIndent = block.getAttribute('blockIndent');
+                const nextIndent = this._indentBehavior.getNextIndent(currentIndent);
+                if (nextIndent) {
+                    writer.setAttribute('blockIndent', nextIndent, block);
+                }
+                else {
+                    writer.removeAttribute('blockIndent', block);
+                }
+            }
+        });
+    }
+    /**
+     * Returns blocks from selection that should have blockIndent selection set.
+     */
+    _getBlocksToChange() {
+        const model = this.editor.model;
+        const selection = model.document.selection;
+        const blocksInSelection = Array.from(selection.getSelectedBlocks());
+        return blocksInSelection.filter(block => this._isIndentationChangeAllowed(block));
+    }
+    /**
+     * Returns false if indentation cannot be applied, i.e.:
+     * - for blocks disallowed by schema declaration
+     * - for blocks in Document Lists (disallowed forward indentation only). See https://github.com/ckeditor/ckeditor5/issues/14155.
+     * Otherwise returns true.
+     */
+    _isIndentationChangeAllowed(element) {
+        const editor = this.editor;
+        if (!editor.model.schema.checkAttribute(element, 'blockIndent')) {
+            return false;
+        }
+        if (!editor.plugins.has('DocumentListUtils')) {
+            return true;
+        }
+        // Only forward indentation is disallowed in list items. This allows the user to outdent blocks that are already indented.
+        if (!this._indentBehavior.isForward) {
+            return true;
+        }
+        const documentListUtils = editor.plugins.get('DocumentListUtils');
+        return !documentListUtils.isListItemBlock(element);
+    }
+}

package/src/indentcommandbehavior/indentbehavior.d.ts

@@ -1,21 +1,25 @@
-/**
- * @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 indent/indentcommandbehavior/indentbehavior
- */
-/**
- * Provides indentation behavior to {@link module:indent/indentblockcommand~IndentBlockCommand}.
- */
-export interface IndentBehavior {
-    /**
-     * Checks if the command should be enabled.
-     */
-    checkEnabled: (indentAttributeValue: string) => boolean;
-    /**
-     * Returns a new indent attribute value based on the current indent.
-     * This method returns `undefined` when the indentation should be removed.
-     */
-    getNextIndent: (indentAttributeValue: string) => string | undefined;
-}
+/**
+ * @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 indent/indentcommandbehavior/indentbehavior
+ */
+/**
+ * Provides indentation behavior to {@link module:indent/indentblockcommand~IndentBlockCommand}.
+ */
+export interface IndentBehavior {
+    /**
+     * The direction of indentation.
+     */
+    isForward: boolean;
+    /**
+     * Checks if the command should be enabled.
+     */
+    checkEnabled: (indentAttributeValue: string) => boolean;
+    /**
+     * Returns a new indent attribute value based on the current indent.
+     * This method returns `undefined` when the indentation should be removed.
+     */
+    getNextIndent: (indentAttributeValue: string) => string | undefined;
+}

package/src/indentcommandbehavior/indentbehavior.js

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