@ckeditor/ckeditor5-indent 40.0.0 → 40.1.0

package/src/indentblockcommand.d.ts

@@ -1,56 +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;
-    /**
-     * 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;
-}
+/**
+ * @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,98 +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() {
-        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);
-    }
-}
+/**
+ * @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,25 +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 {
-    /**
-     * 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;
-}
+/**
+ * @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 {};

package/src/indentcommandbehavior/indentusingclasses.d.ts

@@ -1,39 +1,39 @@
-/**
- * @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/indentusingclasses
- */
-import type { IndentBehavior } from './indentbehavior';
-/**
- * The block indentation behavior that uses classes to set indentation.
- */
-export default class IndentUsingClasses implements IndentBehavior {
-    /**
-     * The direction of indentation.
-     */
-    isForward: boolean;
-    /**
-     * A list of classes used for indentation.
-     */
-    classes: Array<string>;
-    /**
-     * Creates an instance of the indentation behavior.
-     *
-     * @param config.direction The direction of indentation.
-     * @param config.classes A list of classes used for indentation.
-     */
-    constructor(config: {
-        direction: 'forward' | 'backward';
-        classes: Array<string>;
-    });
-    /**
-     * @inheritDoc
-     */
-    checkEnabled(indentAttributeValue: string): boolean;
-    /**
-     * @inheritDoc
-     */
-    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/indentusingclasses
+ */
+import type { IndentBehavior } from './indentbehavior';
+/**
+ * The block indentation behavior that uses classes to set indentation.
+ */
+export default class IndentUsingClasses implements IndentBehavior {
+    /**
+     * The direction of indentation.
+     */
+    isForward: boolean;
+    /**
+     * A list of classes used for indentation.
+     */
+    classes: Array<string>;
+    /**
+     * Creates an instance of the indentation behavior.
+     *
+     * @param config.direction The direction of indentation.
+     * @param config.classes A list of classes used for indentation.
+     */
+    constructor(config: {
+        direction: 'forward' | 'backward';
+        classes: Array<string>;
+    });
+    /**
+     * @inheritDoc
+     */
+    checkEnabled(indentAttributeValue: string): boolean;
+    /**
+     * @inheritDoc
+     */
+    getNextIndent(indentAttributeValue: string): string | undefined;
+}

package/src/indentcommandbehavior/indentusingclasses.js

@@ -1,39 +1,39 @@
-/**
- * @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
- */
-/**
- * The block indentation behavior that uses classes to set indentation.
- */
-export default class IndentUsingClasses {
-    /**
-     * Creates an instance of the indentation behavior.
-     *
-     * @param config.direction The direction of indentation.
-     * @param config.classes A list of classes used for indentation.
-     */
-    constructor(config) {
-        this.isForward = config.direction === 'forward';
-        this.classes = config.classes;
-    }
-    /**
-     * @inheritDoc
-     */
-    checkEnabled(indentAttributeValue) {
-        const currentIndex = this.classes.indexOf(indentAttributeValue);
-        if (this.isForward) {
-            return currentIndex < this.classes.length - 1;
-        }
-        else {
-            return currentIndex >= 0;
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    getNextIndent(indentAttributeValue) {
-        const currentIndex = this.classes.indexOf(indentAttributeValue);
-        const indexStep = this.isForward ? 1 : -1;
-        return this.classes[currentIndex + indexStep];
-    }
-}
+/**
+ * @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
+ */
+/**
+ * The block indentation behavior that uses classes to set indentation.
+ */
+export default class IndentUsingClasses {
+    /**
+     * Creates an instance of the indentation behavior.
+     *
+     * @param config.direction The direction of indentation.
+     * @param config.classes A list of classes used for indentation.
+     */
+    constructor(config) {
+        this.isForward = config.direction === 'forward';
+        this.classes = config.classes;
+    }
+    /**
+     * @inheritDoc
+     */
+    checkEnabled(indentAttributeValue) {
+        const currentIndex = this.classes.indexOf(indentAttributeValue);
+        if (this.isForward) {
+            return currentIndex < this.classes.length - 1;
+        }
+        else {
+            return currentIndex >= 0;
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    getNextIndent(indentAttributeValue) {
+        const currentIndex = this.classes.indexOf(indentAttributeValue);
+        const indexStep = this.isForward ? 1 : -1;
+        return this.classes[currentIndex + indexStep];
+    }
+}

package/src/indentcommandbehavior/indentusingoffset.d.ts

@@ -1,45 +1,45 @@
-/**
- * @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/indentusingoffset
- */
-import type { IndentBehavior } from './indentbehavior';
-/**
- * The block indentation behavior that uses offsets to set indentation.
- */
-export default class IndentUsingOffset implements IndentBehavior {
-    /**
-     * The direction of indentation.
-     */
-    isForward: boolean;
-    /**
-     * The offset of the next indentation step.
-     */
-    offset: number;
-    /**
-     * Indentation unit.
-     */
-    unit: string;
-    /**
-     * Creates an instance of the indentation behavior.
-     *
-     * @param config.direction The direction of indentation.
-     * @param config.offset The offset of the next indentation step.
-     * @param config.unit Indentation unit.
-     */
-    constructor(config: {
-        direction: 'forward' | 'backward';
-        offset: number;
-        unit: string;
-    });
-    /**
-     * @inheritDoc
-     */
-    checkEnabled(indentAttributeValue: string): boolean;
-    /**
-     * @inheritDoc
-     */
-    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/indentusingoffset
+ */
+import type { IndentBehavior } from './indentbehavior';
+/**
+ * The block indentation behavior that uses offsets to set indentation.
+ */
+export default class IndentUsingOffset implements IndentBehavior {
+    /**
+     * The direction of indentation.
+     */
+    isForward: boolean;
+    /**
+     * The offset of the next indentation step.
+     */
+    offset: number;
+    /**
+     * Indentation unit.
+     */
+    unit: string;
+    /**
+     * Creates an instance of the indentation behavior.
+     *
+     * @param config.direction The direction of indentation.
+     * @param config.offset The offset of the next indentation step.
+     * @param config.unit Indentation unit.
+     */
+    constructor(config: {
+        direction: 'forward' | 'backward';
+        offset: number;
+        unit: string;
+    });
+    /**
+     * @inheritDoc
+     */
+    checkEnabled(indentAttributeValue: string): boolean;
+    /**
+     * @inheritDoc
+     */
+    getNextIndent(indentAttributeValue: string): string | undefined;
+}