@ckeditor/ckeditor5-indent 47.6.1 → 48.0.0-alpha.1

package/ckeditor5-metadata.json

@@ -5,17 +5,17 @@
 			"className": "Indent",
 			"description": "Implements the core of the indent feature. It requires compatible plugins, such as indent block or list, to work.",
 			"docs": "features/indent.html",
-			"path": "src/indent.js",
+			"path": "src/indent.ts",
 			"uiComponents": [
 				{
 					"type": "Button",
 					"name": "indent",
-					"iconPath": "@ckeditor/ckeditor5-icons/theme/icons/indent.svg"
+					"iconName": "IconIndent"
 				},
 				{
 					"type": "Button",
 					"name": "outdent",
-					"iconPath": "@ckeditor/ckeditor5-icons/theme/icons/outdent.svg"
+					"iconName": "IconOutdent"
 				}
 			]
 		},
@@ -24,7 +24,7 @@
 			"className": "IndentBlock",
 			"description": "The indent block feature, together with the indent feature, controls the indentation of elements such as paragraphs and headings.",
 			"docs": "features/indent.html",
-			"path": "src/indentblock.js",
+			"path": "src/indentblock.ts",
 			"requires": [
 				"Indent"
 			],
@@ -50,7 +50,7 @@
 			"className": "IndentBlockListIntegration",
 			"description": "Provides block indentation integration for lists, enabling indent and outdent of lists and list items.",
 			"docs": "features/indent.html",
-			"path": "src/integrations/indentblocklistintegration.js",
+			"path": "src/integrations/indentblocklistintegration.ts",
 			"requires": [
 				"IndentBlock"
 			],
@@ -58,7 +58,8 @@
 				{
 					"elements": [
 						"ol",
-						"ul"
+						"ul",
+						"li"
 					],
 					"styles": [
 						"margin-left",
@@ -66,28 +67,15 @@
 					],
 					"_comment": "By default, the plugin uses inline styles for indentation."
 				},
-				{
-					"elements": "li",
-					"styles": [
-						"margin-left",
-						"margin-right"
-					],
-					"_comment": "By default, the plugin uses inline styles for indentation."
-				},
 				{
 					"elements": [
 						"ol",
-						"ul"
+						"ul",
+						"li"
 					],
 					"classes": "*",
 					"isAlternative": true,
 					"_comment": "If classes are defined in `config.indentBlock.classes`, they are used instead of inline styles."
-				},
-				{
-					"elements": "li",
-					"classes": "*",
-					"isAlternative": true,
-					"_comment": "If classes are defined in `config.indentBlock.classes`, they are used instead of inline styles."
 				}
 			]
 		}

package/{src → dist}/indent.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module indent/indent
  */
-import { Plugin } from 'ckeditor5/src/core.js';
+import { Plugin } from '@ckeditor/ckeditor5-core';
 import { IndentEditing } from './indentediting.js';
 import { IndentUI } from './indentui.js';
 /**

package/{src → dist}/indentblock.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module indent/indentblock
  */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
 import { IndentBlockListIntegration } from './integrations/indentblocklistintegration.js';
 /**
  * The block indentation feature.

package/{src → dist}/indentblockcommand.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module indent/indentblockcommand
  */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
+import { Command, type Editor } from '@ckeditor/ckeditor5-core';
 import type { IndentBehavior } from './indentcommandbehavior/indentbehavior.js';
 /**
  * The indent block command.

package/dist/indentcommandbehavior/resetindentusingclasses.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @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/indentcommandbehavior/resetindentusingclasses
+ */
+import { IndentUsingClasses } from './indentusingclasses.js';
+/**
+ * The list item block indentation behavior that resets class-based indentation toward zero.
+ *
+ * Unlike {@link module:indent/indentcommandbehavior/indentusingclasses~IndentUsingClasses}, this behavior
+ * is enabled only in the backward (outdent) direction when a class-based indentation is set.
+ * This is because class-based indentation values cannot be negative, so the only way to reset
+ * them to zero is to remove the class by outdenting.
+ *
+ * @internal
+ */
+export declare class ResetIndentUsingClasses extends IndentUsingClasses {
+    /**
+     * @inheritDoc
+     */
+    checkEnabled(indentAttributeValue: string): boolean;
+}

package/dist/indentcommandbehavior/resetindentusingoffset.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @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/indentcommandbehavior/resetindentusingoffset
+ */
+import { IndentUsingOffset } from './indentusingoffset.js';
+/**
+ * The list item block indentation behavior that resets offset-based indentation toward zero.
+ *
+ * Unlike {@link module:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset}, this behavior
+ * is enabled only when the current indentation value can be moved toward zero:
+ * - for forward direction only when the current offset is negative,
+ * - for backward direction only when the current offset is positive.
+ *
+ * @internal
+ */
+export declare class ResetIndentUsingOffset extends IndentUsingOffset {
+    /**
+     * @inheritDoc
+     */
+    checkEnabled(indentAttributeValue: string): boolean;
+}

package/{src → dist}/indentediting.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module indent/indentediting
  */
-import { Plugin } from 'ckeditor5/src/core.js';
+import { Plugin } from '@ckeditor/ckeditor5-core';
 /**
  * The indent editing feature.
  *

package/{src → dist}/indentui.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 { Plugin } from 'ckeditor5/src/core.js';
+import { Plugin } from '@ckeditor/ckeditor5-core';
 /**
  * The indent UI feature.
  *

package/dist/index.css

@@ -2,3 +2,6 @@
  * @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
  */
+
+
+/*# sourceMappingURL=index.css.map */

package/dist/index.css.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.css"],"names":[],"mappings":";;;;;;AAEA,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC","file":"index.css.map","sourcesContent":["\n\n/*# sourceMappingURL=index.css.map */"]}

package/dist/index.js

@@ -373,6 +373,7 @@ import { _isListItemBlock } from '@ckeditor/ckeditor5-list/dist/index.js';
         const editor = this.editor;
         const model = editor.model;
         const selection = model.document.selection;
+        const listUtils = editor.plugins.get('ListUtils');
         model.change((writer)=>{
             const listItem = this._getFirstListItemIfSelectionIsAtListStart(selection);
             const listItems = [];
@@ -386,7 +387,9 @@ import { _isListItemBlock } from '@ckeditor/ckeditor5-list/dist/index.js';
             } else {
                 listItems.push(listItem);
             }
-            for (const item of listItems){
+            // Expand to all list items in the selected lists to process them together and reduce postfixer usage.
+            const expandedListItems = listUtils.expandListBlocksToCompleteList(listItems);
+            for (const item of expandedListItems){
                 const currentIndent = item.getAttribute('blockIndentList');
                 const nextIndent = this._indentBehavior.getNextIndent(currentIndent);
                 if (nextIndent) {
@@ -472,24 +475,46 @@ import { _isListItemBlock } from '@ckeditor/ckeditor5-list/dist/index.js';
     }
     /**
 	 * Returns `true` if changing the block indentation is allowed for the given list item.
-	 *
-	 * Indentation of a list item is only allowed if it moves toward zero. This means that:
-	 * - when currentIndent = 0, the command should be disabled
-	 * - when currentIndent < 0, only forward indentation should be allowed
-	 * - when currentIndent > 0, only backward indentation should be allowed
-	 *
-	 * For classes-based indentation, the command should be enabled if there is a class to be removed.
 	 */ _isIndentationChangeAllowed(element) {
         if (!element.hasAttribute('blockIndentListItem')) {
             return false;
         }
-        const currentIndent = parseFloat(element.getAttribute('blockIndentListItem'));
-        // Class based indent, allow only outdent.
-        // TODO find a better way, probably use behavior to find out.
-        if (isNaN(currentIndent)) {
-            return !this._indentBehavior.isForward;
-        }
-        return this._indentBehavior.isForward && currentIndent < 0 || !this._indentBehavior.isForward && currentIndent > 0;
+        return this._indentBehavior.checkEnabled(element.getAttribute('blockIndentListItem'));
+    }
+}
+
+/**
+ * The list item block indentation behavior that resets offset-based indentation toward zero.
+ *
+ * Unlike {@link module:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset}, this behavior
+ * is enabled only when the current indentation value can be moved toward zero:
+ * - for forward direction only when the current offset is negative,
+ * - for backward direction only when the current offset is positive.
+ *
+ * @internal
+ */ class ResetIndentUsingOffset extends IndentUsingOffset {
+    /**
+	 * @inheritDoc
+	 */ checkEnabled(indentAttributeValue) {
+        const currentOffset = parseFloat(indentAttributeValue);
+        return this.isForward && currentOffset < 0 || !this.isForward && currentOffset > 0;
+    }
+}
+
+/**
+ * The list item block indentation behavior that resets class-based indentation toward zero.
+ *
+ * Unlike {@link module:indent/indentcommandbehavior/indentusingclasses~IndentUsingClasses}, this behavior
+ * is enabled only in the backward (outdent) direction when a class-based indentation is set.
+ * This is because class-based indentation values cannot be negative, so the only way to reset
+ * them to zero is to remove the class by outdenting.
+ *
+ * @internal
+ */ class ResetIndentUsingClasses extends IndentUsingClasses {
+    /**
+	 * @inheritDoc
+	 */ checkEnabled(indentAttributeValue) {
+        return !this.isForward && !!indentAttributeValue;
     }
 }
 
@@ -515,8 +540,9 @@ import { _isListItemBlock } from '@ckeditor/ckeditor5-list/dist/index.js';
         }
         const config = editor.config.get('indentBlock');
         if (config.classes && config.classes.length) {
-            this._setupConversionUsingClassesForListBlock(config.classes);
-            this._setupConversionUsingClassesForListItemBlock(config.classes);
+            this._setupConversionUsingClasses(config.classes, 'ol', 'blockIndentList', 'list');
+            this._setupConversionUsingClasses(config.classes, 'ul', 'blockIndentList', 'list');
+            this._setupConversionUsingClasses(config.classes, 'li', 'blockIndentListItem', 'item');
             editor.commands.add('indentBlockList', new IndentBlockListCommand(editor, new IndentUsingClasses({
                 direction: 'forward',
                 classes: config.classes
@@ -525,18 +551,19 @@ import { _isListItemBlock } from '@ckeditor/ckeditor5-list/dist/index.js';
                 direction: 'backward',
                 classes: config.classes
             })));
-            editor.commands.add('indentBlockListItem', new IndentBlockListItemCommand(editor, new IndentUsingClasses({
+            editor.commands.add('indentBlockListItem', new IndentBlockListItemCommand(editor, new ResetIndentUsingClasses({
                 direction: 'forward',
                 classes: config.classes
             })));
-            editor.commands.add('outdentBlockListItem', new IndentBlockListItemCommand(editor, new IndentUsingClasses({
+            editor.commands.add('outdentBlockListItem', new IndentBlockListItemCommand(editor, new ResetIndentUsingClasses({
                 direction: 'backward',
                 classes: config.classes
             })));
         } else {
             editor.data.addStyleProcessorRules(addMarginStylesRules);
-            this._setupConversionUsingOffsetForListBlock();
-            this._setupConversionUsingOffsetForListItemBlock();
+            this._setupConversionUsingOffset('ol', 'blockIndentList', 'list');
+            this._setupConversionUsingOffset('ul', 'blockIndentList', 'list');
+            this._setupConversionUsingOffset('li', 'blockIndentListItem', 'item');
             editor.commands.add('indentBlockList', new IndentBlockListCommand(editor, new IndentUsingOffset({
                 direction: 'forward',
                 offset: config.offset,
@@ -547,12 +574,12 @@ import { _isListItemBlock } from '@ckeditor/ckeditor5-list/dist/index.js';
                 offset: config.offset,
                 unit: config.unit
             })));
-            editor.commands.add('indentBlockListItem', new IndentBlockListItemCommand(editor, new IndentUsingOffset({
+            editor.commands.add('indentBlockListItem', new IndentBlockListItemCommand(editor, new ResetIndentUsingOffset({
                 direction: 'forward',
                 offset: config.offset,
                 unit: config.unit
             })));
-            editor.commands.add('outdentBlockListItem', new IndentBlockListItemCommand(editor, new IndentUsingOffset({
+            editor.commands.add('outdentBlockListItem', new IndentBlockListItemCommand(editor, new ResetIndentUsingOffset({
                 direction: 'backward',
                 offset: config.offset,
                 unit: config.unit
@@ -560,6 +587,8 @@ import { _isListItemBlock } from '@ckeditor/ckeditor5-list/dist/index.js';
         }
         const listEditing = editor.plugins.get('ListEditing');
         // Make sure that all items in a single list (items at the same level & listType) have the same blockIndentList attribute value.
+        // Also make sure that all block in a single list item (blocks with the same listItemId) have the same
+        // blockIndentListItem attribute value.
         listEditing.on('postFixer', (evt, { listNodes, writer })=>{
             for (const { node, previousNodeInList } of listNodes){
                 // This is a first item of a nested list.
@@ -662,43 +691,23 @@ import { _isListItemBlock } from '@ckeditor/ckeditor5-list/dist/index.js';
         outdentCommand.registerChildCommand(editor.commands.get('outdentBlockListItem'));
     }
     /**
-	 * Setups conversion for list block indent using offset indents.
-	 */ _setupConversionUsingOffsetForListBlock() {
-        const editor = this.editor;
-        const conversion = editor.conversion;
-        const locale = editor.locale;
-        const marginProperty = locale.contentLanguageDirection === 'rtl' ? 'margin-right' : 'margin-left';
-        const listEditing = editor.plugins.get('ListEditing');
-        conversion.for('upcast').add((dispatcher)=>{
-            dispatcher.on('element:ol', listBlockIndentUpcastConverter('blockIndentList', marginProperty));
-            dispatcher.on('element:ul', listBlockIndentUpcastConverter('blockIndentList', marginProperty));
-        });
-        listEditing.registerDowncastStrategy({
-            scope: 'list',
-            attributeName: 'blockIndentList',
-            setAttributeOnDowncast (writer, value, element) {
-                if (value) {
-                    writer.setStyle(marginProperty, value, element);
-                }
-            }
-        });
-    }
-    /**
-	 * Setups conversion for list item block indent using offset indents.
-	 */ _setupConversionUsingOffsetForListItemBlock() {
+	 * Setups conversion for list block indent using offset.
+	 */ _setupConversionUsingOffset(element, attributeName, scope) {
         const editor = this.editor;
         const locale = editor.locale;
         const conversion = editor.conversion;
         const marginProperty = locale.contentLanguageDirection === 'rtl' ? 'margin-right' : 'margin-left';
         const listEditing = editor.plugins.get('ListEditing');
         conversion.for('upcast').add((dispatcher)=>{
-            dispatcher.on('element:li', listBlockIndentUpcastConverter('blockIndentListItem', marginProperty), {
+            dispatcher.on(`element:${element}`, listBlockIndentUpcastConverter(attributeName, (item)=>item.getStyle(marginProperty), (consumable, item)=>consumable.consume(item, {
+                    styles: marginProperty
+                })), {
                 priority: 'low'
             });
         });
         listEditing.registerDowncastStrategy({
-            scope: 'item',
-            attributeName: 'blockIndentListItem',
+            scope,
+            attributeName,
             setAttributeOnDowncast (writer, value, element) {
                 if (value) {
                     writer.setStyle(marginProperty, value, element);
@@ -708,38 +717,20 @@ import { _isListItemBlock } from '@ckeditor/ckeditor5-list/dist/index.js';
     }
     /**
 	 * Setups conversion for list block indent using classes.
-	 */ _setupConversionUsingClassesForListBlock(classes) {
-        const editor = this.editor;
-        const conversion = editor.conversion;
-        const listEditing = editor.plugins.get('ListEditing');
-        conversion.for('upcast').add((dispatcher)=>{
-            dispatcher.on('element:ol', listBlockIndentUpcastConverterUsingClasses('blockIndentList', classes));
-            dispatcher.on('element:ul', listBlockIndentUpcastConverterUsingClasses('blockIndentList', classes));
-        });
-        listEditing.registerDowncastStrategy({
-            scope: 'list',
-            attributeName: 'blockIndentList',
-            setAttributeOnDowncast (writer, value, element) {
-                if (value) {
-                    writer.addClass(value, element);
-                }
-            }
-        });
-    }
-    /**
-	 * Setups conversion for list item block indent using classes.
-	 */ _setupConversionUsingClassesForListItemBlock(classes) {
+	 */ _setupConversionUsingClasses(classes, element, attributeName, scope) {
         const editor = this.editor;
         const conversion = editor.conversion;
         const listEditing = editor.plugins.get('ListEditing');
         conversion.for('upcast').add((dispatcher)=>{
-            dispatcher.on('element:li', listBlockIndentUpcastConverterUsingClasses('blockIndentListItem', classes), {
+            dispatcher.on(`element:${element}`, listBlockIndentUpcastConverter(attributeName, (item)=>classes.find((cls)=>item.hasClass(cls)), (consumable, item, value)=>consumable.consume(item, {
+                    classes: value
+                })), {
                 priority: 'low'
             });
         });
         listEditing.registerDowncastStrategy({
-            scope: 'item',
-            attributeName: 'blockIndentListItem',
+            scope,
+            attributeName,
             setAttributeOnDowncast (writer, value, element) {
                 if (value) {
                     writer.addClass(value, element);
@@ -748,15 +739,21 @@ import { _isListItemBlock } from '@ckeditor/ckeditor5-list/dist/index.js';
         });
     }
 }
-function listBlockIndentUpcastConverterUsingClasses(attributeName, classes) {
+/**
+ * Returns an upcast converter for block list indentation.
+ *
+ * @param attributeName The name of the model attribute.
+ * @param getValue A function to get the value from the view element.
+ * @param consume A function to consume the view element.
+ * @returns A callback for the upcast conversion.
+ */ function listBlockIndentUpcastConverter(attributeName, getValue, consume) {
     return (evt, data, conversionApi)=>{
         const { writer, consumable } = conversionApi;
         if (!data.modelRange) {
             Object.assign(data, conversionApi.convertChildren(data.viewItem, data.modelCursor));
         }
-        const viewClasses = Array.from(data.viewItem.getClassNames());
-        const matchedClass = classes.find((cls)=>viewClasses.includes(cls));
-        if (matchedClass === undefined) {
+        const value = getValue(data.viewItem);
+        if (value === undefined) {
             return;
         }
         let applied = false;
@@ -773,48 +770,19 @@ function listBlockIndentUpcastConverterUsingClasses(attributeName, classes) {
             if (item.getAttribute('listIndent') !== indentLevel) {
                 continue;
             }
-            writer.setAttribute(attributeName, matchedClass, item);
-            applied = true;
-        }
-        if (applied) {
-            consumable.consume(data.viewItem, {
-                classes: matchedClass
-            });
-        }
-    };
-}
-function listBlockIndentUpcastConverter(attributeName, marginProperty) {
-    return (evt, data, conversionApi)=>{
-        const { writer, consumable } = conversionApi;
-        if (!data.modelRange) {
-            Object.assign(data, conversionApi.convertChildren(data.viewItem, data.modelCursor));
-        }
-        const marginValue = data.viewItem.getStyle(marginProperty);
-        let applied = false;
-        let indentLevel;
-        for (const item of data.modelRange.getItems({
-            shallow: true
-        })){
-            if (indentLevel === undefined) {
-                indentLevel = item.getAttribute('listIndent');
-            }
-            if (item.hasAttribute(attributeName)) {
-                continue;
-            }
-            if (item.getAttribute('listIndent') !== indentLevel) {
-                continue;
-            }
-            writer.setAttribute(attributeName, marginValue, item);
+            writer.setAttribute(attributeName, value, item);
             applied = true;
         }
         if (applied) {
-            consumable.consume(data.viewItem, {
-                styles: marginProperty
-            });
+            consume(consumable, data.viewItem, value);
         }
     };
 }
-function ensureIndentValuesConsistency(attributeName, node, previousNodeInList, writer) {
+/**
+ * Ensures that two nodes have the same value of the given attribute.
+ * If the values are different, the attribute value from the previous node is applied to the given node.
+ * Returns true if the attribute value was changed, false otherwise.
+ */ function ensureIndentValuesConsistency(attributeName, node, previousNodeInList, writer) {
     const prevNodeIndentListValue = previousNodeInList.getAttribute(attributeName);
     if (node.getAttribute(attributeName) === prevNodeIndentListValue) {
         return false;