@ckeditor/ckeditor5-indent 47.5.0 → 47.6.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-indent",
-  "version": "47.5.0",
+  "version": "47.6.0-alpha.0",
   "description": "Block indentation feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,14 +13,14 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "47.5.0",
-    "@ckeditor/ckeditor5-engine": "47.5.0",
-    "@ckeditor/ckeditor5-icons": "47.5.0",
-    "@ckeditor/ckeditor5-heading": "47.5.0",
-    "@ckeditor/ckeditor5-list": "47.5.0",
-    "@ckeditor/ckeditor5-ui": "47.5.0",
-    "@ckeditor/ckeditor5-utils": "47.5.0",
-    "ckeditor5": "47.5.0"
+    "@ckeditor/ckeditor5-core": "47.6.0-alpha.0",
+    "@ckeditor/ckeditor5-engine": "47.6.0-alpha.0",
+    "@ckeditor/ckeditor5-icons": "47.6.0-alpha.0",
+    "@ckeditor/ckeditor5-heading": "47.6.0-alpha.0",
+    "@ckeditor/ckeditor5-list": "47.6.0-alpha.0",
+    "@ckeditor/ckeditor5-ui": "47.6.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "47.6.0-alpha.0",
+    "ckeditor5": "47.6.0-alpha.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "SEE LICENSE IN LICENSE.md",

package/src/augmentation.d.ts

@@ -2,7 +2,7 @@
  * @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 type { IndentBlockConfig, Indent, IndentBlock, IndentUI, IndentBlockCommand } from './index.js';
+import type { IndentBlockConfig, Indent, IndentBlock, IndentUI, IndentBlockCommand, IndentBlockListIntegration, IndentBlockListCommand, IndentBlockListItemCommand } from './index.js';
 declare module '@ckeditor/ckeditor5-core' {
     interface EditorConfig {
         /**
@@ -16,9 +16,14 @@ declare module '@ckeditor/ckeditor5-core' {
         [Indent.pluginName]: Indent;
         [IndentBlock.pluginName]: IndentBlock;
         [IndentUI.pluginName]: IndentUI;
+        [IndentBlockListIntegration.pluginName]: IndentBlockListIntegration;
     }
     interface CommandsMap {
         indentBlock: IndentBlockCommand;
         outdentBlock: IndentBlockCommand;
+        indentBlockList: IndentBlockListCommand;
+        outdentBlockList: IndentBlockListCommand;
+        indentBlockListItem: IndentBlockListItemCommand;
+        outdentBlockListItem: IndentBlockListItemCommand;
     }
 }

package/src/indentblock.d.ts

@@ -6,6 +6,7 @@
  * @module indent/indentblock
  */
 import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import { IndentBlockListIntegration } from './integrations/indentblocklistintegration.js';
 /**
  * The block indentation feature.
  *
@@ -27,6 +28,10 @@ export declare class IndentBlock extends Plugin {
      * @inheritDoc
      */
     static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof IndentBlockListIntegration];
     /**
      * @inheritDoc
      */

package/src/indentblock.js

@@ -10,6 +10,7 @@ import { addMarginStylesRules } from 'ckeditor5/src/engine.js';
 import { IndentBlockCommand } from './indentblockcommand.js';
 import { IndentUsingOffset } from './indentcommandbehavior/indentusingoffset.js';
 import { IndentUsingClasses } from './indentcommandbehavior/indentusingclasses.js';
+import { IndentBlockListIntegration } from './integrations/indentblocklistintegration.js';
 const DEFAULT_ELEMENTS = ['paragraph', 'heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6'];
 /**
  * The block indentation feature.
@@ -42,6 +43,12 @@ export class IndentBlock extends Plugin {
     static get isOfficialPlugin() {
         return true;
     }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [IndentBlockListIntegration];
+    }
     /**
      * @inheritDoc
      */

package/src/indentcommandbehavior/indentusingclasses.js

@@ -44,6 +44,8 @@ export class IndentUsingClasses {
     getNextIndent(indentAttributeValue) {
         const currentIndex = this.classes.indexOf(indentAttributeValue);
         const indexStep = this.isForward ? 1 : -1;
-        return this.classes[currentIndex + indexStep];
+        const nextIndex = currentIndex + indexStep;
+        const nextIndexClamped = Math.min(nextIndex, this.classes.length - 1);
+        return this.classes[nextIndexClamped];
     }
 }

package/src/indentcommandbehavior/indentusingoffset.js

@@ -46,6 +46,9 @@ export class IndentUsingOffset {
     getNextIndent(indentAttributeValue) {
         const currentOffset = parseFloat(indentAttributeValue || '0');
         const isSameUnit = !indentAttributeValue || indentAttributeValue.endsWith(this.unit);
+        if (currentOffset < 0) {
+            return;
+        }
         if (!isSameUnit) {
             return this.isForward ? this.offset + this.unit : undefined;
         }

package/src/index.d.ts

@@ -10,6 +10,9 @@ export { IndentEditing } from './indentediting.js';
 export { IndentUI } from './indentui.js';
 export { IndentBlock } from './indentblock.js';
 export { IndentBlockCommand } from './indentblockcommand.js';
+export { IndentBlockListIntegration } from './integrations/indentblocklistintegration.js';
+export { IndentBlockListCommand } from './integrations/indentblocklistcommand.js';
+export { IndentBlockListItemCommand } from './integrations/indentblocklistitemcommand.js';
 export type { IndentBlockConfig } from './indentconfig.js';
 export type { IndentBehavior } from './indentcommandbehavior/indentbehavior.js';
 export { IndentUsingClasses as _IndentUsingClasses } from './indentcommandbehavior/indentusingclasses.js';

package/src/index.js

@@ -10,6 +10,9 @@ export { IndentEditing } from './indentediting.js';
 export { IndentUI } from './indentui.js';
 export { IndentBlock } from './indentblock.js';
 export { IndentBlockCommand } from './indentblockcommand.js';
+export { IndentBlockListIntegration } from './integrations/indentblocklistintegration.js';
+export { IndentBlockListCommand } from './integrations/indentblocklistcommand.js';
+export { IndentBlockListItemCommand } from './integrations/indentblocklistitemcommand.js';
 export { IndentUsingClasses as _IndentUsingClasses } from './indentcommandbehavior/indentusingclasses.js';
 export { IndentUsingOffset as _IndentUsingOffset } from './indentcommandbehavior/indentusingoffset.js';
 import './augmentation.js';

package/src/integrations/indentblocklistcommand.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @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
+ */
+/**
+ * @module indent/integrations/indentblocklistcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+import type { IndentBehavior } from '../indentcommandbehavior/indentbehavior.js';
+/**
+ * The indent block list command.
+ *
+ * The command is registered by the {@link module:indent/integrations/indentblocklistintegration~IndentBlockListIntegration} as
+ * `'indentBlockList'` for indenting lists and `'outdentBlockList'` for outdenting lists.
+ *
+ * To increase/decrease block indentation of the list the selection must be at the start of the first top–level list item
+ * in the list.
+ *
+ * To increase block indentation of the list, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'indentBlockList' );
+ * ```
+ *
+ * To decrease block indentation of the list, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'outdentBlockList' );
+ * ```
+ */
+export declare class IndentBlockListCommand extends Command {
+    /**
+     * The command's indentation behavior.
+     */
+    private readonly _indentBehavior;
+    /**
+     * Creates an instance of the command.
+     */
+    constructor(editor: Editor, indentBehavior: IndentBehavior);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options Command options.
+     * @param options.firstListOnly When `true`, indentation is applied only to the first list at the beginning of the selection.
+     * When `false` or omitted, indentation is applied to all lists of the selection.
+     */
+    execute(options?: {
+        firstListOnly?: boolean;
+    }): void;
+    /**
+     * Returns the list item at the beginning of the current selection if it is the first top–level list item in the list.
+     * Otherwise, returns `null`.
+     */
+    private _getFirstListItemIfSelectionIsAtListStart;
+}

package/src/integrations/indentblocklistcommand.js

@@ -0,0 +1,108 @@
+/**
+ * @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
+ */
+/**
+ * @module indent/integrations/indentblocklistcommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+import { _isListItemBlock } from '@ckeditor/ckeditor5-list';
+/**
+ * The indent block list command.
+ *
+ * The command is registered by the {@link module:indent/integrations/indentblocklistintegration~IndentBlockListIntegration} as
+ * `'indentBlockList'` for indenting lists and `'outdentBlockList'` for outdenting lists.
+ *
+ * To increase/decrease block indentation of the list the selection must be at the start of the first top–level list item
+ * in the list.
+ *
+ * To increase block indentation of the list, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'indentBlockList' );
+ * ```
+ *
+ * To decrease block indentation of the list, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'outdentBlockList' );
+ * ```
+ */
+export class IndentBlockListCommand extends Command {
+    /**
+     * The command's indentation behavior.
+     */
+    _indentBehavior;
+    /**
+     * Creates an instance of the command.
+     */
+    constructor(editor, indentBehavior) {
+        super(editor);
+        this._indentBehavior = indentBehavior;
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const listItem = this._getFirstListItemIfSelectionIsAtListStart(this.editor.model.document.selection);
+        this.isEnabled = !!listItem && this._indentBehavior.checkEnabled(listItem.getAttribute('blockIndentList'));
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options Command options.
+     * @param options.firstListOnly When `true`, indentation is applied only to the first list at the beginning of the selection.
+     * When `false` or omitted, indentation is applied to all lists of the selection.
+     */
+    execute(options = {}) {
+        const editor = this.editor;
+        const model = editor.model;
+        const selection = model.document.selection;
+        model.change(writer => {
+            const listItem = this._getFirstListItemIfSelectionIsAtListStart(selection);
+            const listItems = [];
+            if (!options.firstListOnly) {
+                const blocks = Array.from(selection.getSelectedBlocks());
+                for (const block of blocks) {
+                    if (_isListItemBlock(block) &&
+                        block.getAttribute('listIndent') === 0 &&
+                        model.schema.checkAttribute(block, 'blockIndentList')) {
+                        listItems.push(block);
+                    }
+                }
+            }
+            else {
+                listItems.push(listItem);
+            }
+            for (const item of listItems) {
+                const currentIndent = item.getAttribute('blockIndentList');
+                const nextIndent = this._indentBehavior.getNextIndent(currentIndent);
+                if (nextIndent) {
+                    writer.setAttribute('blockIndentList', nextIndent, item);
+                }
+                else {
+                    writer.removeAttribute('blockIndentList', item);
+                }
+            }
+        });
+    }
+    /**
+     * Returns the list item at the beginning of the current selection if it is the first top–level list item in the list.
+     * Otherwise, returns `null`.
+     */
+    _getFirstListItemIfSelectionIsAtListStart(selection) {
+        const position = selection.getFirstPosition();
+        const listUtils = this.editor.plugins.get('ListUtils');
+        const parent = position.parent;
+        const schema = this.editor.model.schema;
+        if (position.isAtStart &&
+            _isListItemBlock(parent) &&
+            parent.getAttribute('listIndent') == 0 &&
+            schema.checkAttribute(parent, 'blockIndentList') &&
+            listUtils.isFirstListItemInList(parent)) {
+            return parent;
+        }
+        return null;
+    }
+}

package/src/integrations/indentblocklistintegration.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @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 { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * This integration enables using block indentation feature with lists.
+ */
+export declare class IndentBlockListIntegration extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "IndentBlockListIntegration";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Setups conversion for list block indent using offset indents.
+     */
+    private _setupConversionUsingOffsetForListBlock;
+    /**
+     * Setups conversion for list item block indent using offset indents.
+     */
+    private _setupConversionUsingOffsetForListItemBlock;
+    /**
+     * Setups conversion for list block indent using classes.
+     */
+    private _setupConversionUsingClassesForListBlock;
+    /**
+     * Setups conversion for list item block indent using classes.
+     */
+    private _setupConversionUsingClassesForListItemBlock;
+}