@ckeditor/ckeditor5-indent 38.1.1 → 38.2.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-indent",
-  "version": "38.1.1",
+  "version": "38.2.0-alpha.1",
   "description": "Block indentation feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -11,8 +11,9 @@
     "ckeditor5-dll"
   ],
   "main": "src/index.js",
+  "type": "module",
   "dependencies": {
-    "ckeditor5": "38.1.1"
+    "ckeditor5": "38.2.0-alpha.1"
   },
   "engines": {
     "node": ">=16.0.0",

package/src/augmentation.d.ts

@@ -1,24 +1,24 @@
-/**
- * @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
- */
-import type { IndentBlockConfig, Indent, IndentBlock, IndentUI, IndentBlockCommand } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:indent/indentblock~IndentBlock block indentation feature}.
-         *
-         * Read more in {@link module:indent/indentconfig~IndentBlockConfig}.
-         */
-        indentBlock?: IndentBlockConfig;
-    }
-    interface PluginsMap {
-        [Indent.pluginName]: Indent;
-        [IndentBlock.pluginName]: IndentBlock;
-        [IndentUI.pluginName]: IndentUI;
-    }
-    interface CommandsMap {
-        indentBlock: IndentBlockCommand;
-        outdentBlock: IndentBlockCommand;
-    }
-}
+/**
+ * @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
+ */
+import type { IndentBlockConfig, Indent, IndentBlock, IndentUI, IndentBlockCommand } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:indent/indentblock~IndentBlock block indentation feature}.
+         *
+         * Read more in {@link module:indent/indentconfig~IndentBlockConfig}.
+         */
+        indentBlock?: IndentBlockConfig;
+    }
+    interface PluginsMap {
+        [Indent.pluginName]: Indent;
+        [IndentBlock.pluginName]: IndentBlock;
+        [IndentUI.pluginName]: IndentUI;
+    }
+    interface CommandsMap {
+        indentBlock: IndentBlockCommand;
+        outdentBlock: IndentBlockCommand;
+    }
+}

package/src/augmentation.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/indent.d.ts

@@ -1,40 +1,40 @@
-/**
- * @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/indent
- */
-import { Plugin } from 'ckeditor5/src/core';
-import IndentEditing from './indentediting';
-import IndentUI from './indentui';
-/**
- * The indent feature.
- *
- * This plugin acts as a single entry point plugin for other features that implement indentation of elements like lists or paragraphs.
- *
- * The compatible features are:
- *
- * * The {@link module:list/list~List} or {@link module:list/list/listediting~ListEditing} feature for list indentation.
- * * The {@link module:indent/indentblock~IndentBlock} feature for block indentation.
- *
- * This is a "glue" plugin that loads the following plugins:
- *
- * * The {@link module:indent/indentediting~IndentEditing indent editing feature}.
- * * The {@link module:indent/indentui~IndentUI indent UI feature}.
- *
- * The dependent plugins register the `'indent'` and `'outdent'` commands and introduce the `'indent'` and `'outdent'` buttons
- * that allow to increase or decrease text indentation of supported elements.
- *
- * **Note**: In order for the commands and buttons to work, at least one of compatible features is required.
- */
-export default class Indent extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Indent";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof IndentEditing, typeof IndentUI];
-}
+/**
+ * @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/indent
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import IndentEditing from './indentediting.js';
+import IndentUI from './indentui.js';
+/**
+ * The indent feature.
+ *
+ * This plugin acts as a single entry point plugin for other features that implement indentation of elements like lists or paragraphs.
+ *
+ * The compatible features are:
+ *
+ * * The {@link module:list/list~List} or {@link module:list/list/listediting~ListEditing} feature for list indentation.
+ * * The {@link module:indent/indentblock~IndentBlock} feature for block indentation.
+ *
+ * This is a "glue" plugin that loads the following plugins:
+ *
+ * * The {@link module:indent/indentediting~IndentEditing indent editing feature}.
+ * * The {@link module:indent/indentui~IndentUI indent UI feature}.
+ *
+ * The dependent plugins register the `'indent'` and `'outdent'` commands and introduce the `'indent'` and `'outdent'` buttons
+ * that allow to increase or decrease text indentation of supported elements.
+ *
+ * **Note**: In order for the commands and buttons to work, at least one of compatible features is required.
+ */
+export default class Indent extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Indent";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof IndentEditing, typeof IndentUI];
+}

package/src/indent.js

@@ -1,44 +1,44 @@
-/**
- * @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/indent
- */
-import { Plugin } from 'ckeditor5/src/core';
-import IndentEditing from './indentediting';
-import IndentUI from './indentui';
-/**
- * The indent feature.
- *
- * This plugin acts as a single entry point plugin for other features that implement indentation of elements like lists or paragraphs.
- *
- * The compatible features are:
- *
- * * The {@link module:list/list~List} or {@link module:list/list/listediting~ListEditing} feature for list indentation.
- * * The {@link module:indent/indentblock~IndentBlock} feature for block indentation.
- *
- * This is a "glue" plugin that loads the following plugins:
- *
- * * The {@link module:indent/indentediting~IndentEditing indent editing feature}.
- * * The {@link module:indent/indentui~IndentUI indent UI feature}.
- *
- * The dependent plugins register the `'indent'` and `'outdent'` commands and introduce the `'indent'` and `'outdent'` buttons
- * that allow to increase or decrease text indentation of supported elements.
- *
- * **Note**: In order for the commands and buttons to work, at least one of compatible features is required.
- */
-export default class Indent extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Indent';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [IndentEditing, IndentUI];
-    }
-}
+/**
+ * @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/indent
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import IndentEditing from './indentediting.js';
+import IndentUI from './indentui.js';
+/**
+ * The indent feature.
+ *
+ * This plugin acts as a single entry point plugin for other features that implement indentation of elements like lists or paragraphs.
+ *
+ * The compatible features are:
+ *
+ * * The {@link module:list/list~List} or {@link module:list/list/listediting~ListEditing} feature for list indentation.
+ * * The {@link module:indent/indentblock~IndentBlock} feature for block indentation.
+ *
+ * This is a "glue" plugin that loads the following plugins:
+ *
+ * * The {@link module:indent/indentediting~IndentEditing indent editing feature}.
+ * * The {@link module:indent/indentui~IndentUI indent UI feature}.
+ *
+ * The dependent plugins register the `'indent'` and `'outdent'` commands and introduce the `'indent'` and `'outdent'` buttons
+ * that allow to increase or decrease text indentation of supported elements.
+ *
+ * **Note**: In order for the commands and buttons to work, at least one of compatible features is required.
+ */
+export default class Indent extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Indent';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [IndentEditing, IndentUI];
+    }
+}

package/src/indentblock.d.ts

@@ -1,42 +1,42 @@
-/**
- * @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, type Editor } from 'ckeditor5/src/core';
-/**
- * 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: Editor);
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "IndentBlock";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Setups conversion for using offset indents.
-     */
-    private _setupConversionUsingOffset;
-    /**
-     * Setups conversion for using classes.
-     */
-    private _setupConversionUsingClasses;
-}
+/**
+ * @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, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * 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: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "IndentBlock";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Setups conversion for using offset indents.
+     */
+    private _setupConversionUsingOffset;
+    /**
+     * Setups conversion for using classes.
+     */
+    private _setupConversionUsingClasses;
+}

package/src/indentblock.js

@@ -1,142 +1,142 @@
-/**
- * @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.js';
+import { addMarginRules } from 'ckeditor5/src/engine.js';
+import IndentBlockCommand from './indentblockcommand.js';
+import IndentUsingOffset from './indentcommandbehavior/indentusingoffset.js';
+import IndentUsingClasses from './indentcommandbehavior/indentusingclasses.js';
+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);
+    }
+}