@ckeditor/ckeditor5-indent 0.0.0-internal-20241017.0

package/lang/translations/ur.po

@@ -0,0 +1,26 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Urdu (https://app.transifex.com/ckeditor/teams/11143/ur/)\n"
+"Language: ur\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the increase indentation feature."
+msgid "Increase indent"
+msgstr "حاشیہ بڑھائیں"
+
+msgctxt "Toolbar button tooltip for the decrease indentation feature."
+msgid "Decrease indent"
+msgstr "حاشیہ گھٹائیں"

package/lang/translations/uz.po

@@ -0,0 +1,26 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Uzbek (https://app.transifex.com/ckeditor/teams/11143/uz/)\n"
+"Language: uz\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the increase indentation feature."
+msgid "Increase indent"
+msgstr "chekinishni oshirish"
+
+msgctxt "Toolbar button tooltip for the decrease indentation feature."
+msgid "Decrease indent"
+msgstr "chekinishni kamaytirish"

package/lang/translations/vi.po

@@ -0,0 +1,26 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Vietnamese (https://app.transifex.com/ckeditor/teams/11143/vi/)\n"
+"Language: vi\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the increase indentation feature."
+msgid "Increase indent"
+msgstr "Tăng lề"
+
+msgctxt "Toolbar button tooltip for the decrease indentation feature."
+msgid "Decrease indent"
+msgstr "Giảm lề"

package/lang/translations/zh-cn.po

@@ -0,0 +1,26 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Chinese (China) (https://app.transifex.com/ckeditor/teams/11143/zh_CN/)\n"
+"Language: zh_CN\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the increase indentation feature."
+msgid "Increase indent"
+msgstr "增加缩进"
+
+msgctxt "Toolbar button tooltip for the decrease indentation feature."
+msgid "Decrease indent"
+msgstr "减少缩进"

package/lang/translations/zh.po

@@ -0,0 +1,26 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Chinese (Taiwan) (https://app.transifex.com/ckeditor/teams/11143/zh_TW/)\n"
+"Language: zh_TW\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the increase indentation feature."
+msgid "Increase indent"
+msgstr "增加縮排"
+
+msgctxt "Toolbar button tooltip for the decrease indentation feature."
+msgid "Decrease indent"
+msgstr "減少縮排"

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@ckeditor/ckeditor5-indent",
+  "version": "0.0.0-internal-20241017.0",
+  "description": "Block indentation feature for CKEditor 5.",
+  "keywords": [
+    "ckeditor",
+    "ckeditor5",
+    "ckeditor 5",
+    "ckeditor5-feature",
+    "ckeditor5-plugin",
+    "ckeditor5-dll"
+  ],
+  "type": "module",
+  "main": "src/index.js",
+  "dependencies": {
+    "@ckeditor/ckeditor5-core": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-engine": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-ui": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-utils": "0.0.0-internal-20241017.0",
+    "ckeditor5": "0.0.0-internal-20241017.0"
+  },
+  "author": "CKSource (http://cksource.com/)",
+  "license": "GPL-2.0-or-later",
+  "homepage": "https://ckeditor.com/ckeditor-5",
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5.git",
+    "directory": "packages/ckeditor5-indent"
+  },
+  "files": [
+    "dist",
+    "lang",
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "theme",
+    "build",
+    "ckeditor5-metadata.json",
+    "CHANGELOG.md"
+  ],
+  "types": "src/index.d.ts"
+}

package/src/augmentation.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license Copyright (c) 2003-2024, 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

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2024, 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

@@ -0,0 +1,44 @@
+/**
+ * @license Copyright (c) 2003-2024, 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 isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof IndentEditing, typeof IndentUI];
+}

package/src/indent.js

@@ -0,0 +1,50 @@
+/**
+ * @license Copyright (c) 2003-2024, 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 isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [IndentEditing, IndentUI];
+    }
+}

package/src/indentblock.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @license Copyright (c) 2003-2024, 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
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @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

@@ -0,0 +1,153 @@
+/**
+ * @license Copyright (c) 2003-2024, 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
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @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

@@ -0,0 +1,56 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+import type { IndentBehavior } from './indentcommandbehavior/indentbehavior.js';
+/**
+ * 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

@@ -0,0 +1,98 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+import { first } from 'ckeditor5/src/utils.js';
+/**
+ * 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('ListUtils')) {
+            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('ListUtils');
+        return !documentListUtils.isListItemBlock(element);
+    }
+}