@ckeditor/ckeditor5-indent 40.0.0 → 40.1.0

package/src/indentcommandbehavior/indentusingoffset.js

@@ -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
- */
-/**
- * The block indentation behavior that uses offsets to set indentation.
- */
-export default class IndentUsingOffset {
-    /**
-     * 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) {
-        this.isForward = config.direction === 'forward';
-        this.offset = config.offset;
-        this.unit = config.unit;
-    }
-    /**
-     * @inheritDoc
-     */
-    checkEnabled(indentAttributeValue) {
-        const currentOffset = parseFloat(indentAttributeValue || '0');
-        // The command is always enabled for forward indentation.
-        return this.isForward || currentOffset > 0;
-    }
-    /**
-     * @inheritDoc
-     */
-    getNextIndent(indentAttributeValue) {
-        const currentOffset = parseFloat(indentAttributeValue || '0');
-        const isSameUnit = !indentAttributeValue || indentAttributeValue.endsWith(this.unit);
-        if (!isSameUnit) {
-            return this.isForward ? this.offset + this.unit : undefined;
-        }
-        const nextOffset = this.isForward ? this.offset : -this.offset;
-        const offsetToSet = currentOffset + nextOffset;
-        return offsetToSet > 0 ? offsetToSet + this.unit : 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
+ */
+/**
+ * The block indentation behavior that uses offsets to set indentation.
+ */
+export default class IndentUsingOffset {
+    /**
+     * 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) {
+        this.isForward = config.direction === 'forward';
+        this.offset = config.offset;
+        this.unit = config.unit;
+    }
+    /**
+     * @inheritDoc
+     */
+    checkEnabled(indentAttributeValue) {
+        const currentOffset = parseFloat(indentAttributeValue || '0');
+        // The command is always enabled for forward indentation.
+        return this.isForward || currentOffset > 0;
+    }
+    /**
+     * @inheritDoc
+     */
+    getNextIndent(indentAttributeValue) {
+        const currentOffset = parseFloat(indentAttributeValue || '0');
+        const isSameUnit = !indentAttributeValue || indentAttributeValue.endsWith(this.unit);
+        if (!isSameUnit) {
+            return this.isForward ? this.offset + this.unit : undefined;
+        }
+        const nextOffset = this.isForward ? this.offset : -this.offset;
+        const offsetToSet = currentOffset + nextOffset;
+        return offsetToSet > 0 ? offsetToSet + this.unit : undefined;
+    }
+}

package/src/indentconfig.d.ts

@@ -1,72 +1,72 @@
-/**
- * @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/indentconfig
- */
-/**
- * The configuration of the block indentation feature.
- *
- * If no {@link module:indent/indentconfig~IndentBlockConfig#classes} are set, the block indentation feature will use
- * {@link module:indent/indentconfig~IndentBlockConfig#offset} and {@link module:indent/indentconfig~IndentBlockConfig#unit} to
- * create indentation steps.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		indentBlock: {
- * 			offset: 2,
- * 			unit: 'em'
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * Alternatively, the block indentation feature may set one of defined {@link module:indent/indentconfig~IndentBlockConfig#classes} as
- * indentation steps:
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		indentBlock: {
- * 			classes: [
- * 				'indent-a', // The first step - smallest indentation.
- * 				'indent-b',
- * 				'indent-c',
- * 				'indent-d',
- * 				'indent-e' // The last step - biggest indentation.
- * 			]
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * In the example above only 5 indentation steps will be available.
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface IndentBlockConfig {
-    /**
-     * The size of indentation {@link module:indent/indentconfig~IndentBlockConfig#unit units} for each indentation step.
-     *
-     * @default 40
-     */
-    offset?: number;
-    /**
-     * The unit used for indentation {@link module:indent/indentconfig~IndentBlockConfig#offset}.
-     *
-     * @default 'px'
-     */
-    unit?: string;
-    /**
-     * An optional list of classes to use for indenting the editor content. If not set or set to an empty array, no classes will be used.
-     * The {@link module:indent/indentconfig~IndentBlockConfig#unit `indentBlock.unit`} and
-     * {@link module:indent/indentconfig~IndentBlockConfig#offset `indentBlock.offset`} properties will be used instead.
-     *
-     * @default undefined
-     */
-    classes?: Array<string>;
-}
+/**
+ * @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/indentconfig
+ */
+/**
+ * The configuration of the block indentation feature.
+ *
+ * If no {@link module:indent/indentconfig~IndentBlockConfig#classes} are set, the block indentation feature will use
+ * {@link module:indent/indentconfig~IndentBlockConfig#offset} and {@link module:indent/indentconfig~IndentBlockConfig#unit} to
+ * create indentation steps.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		indentBlock: {
+ * 			offset: 2,
+ * 			unit: 'em'
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * Alternatively, the block indentation feature may set one of defined {@link module:indent/indentconfig~IndentBlockConfig#classes} as
+ * indentation steps:
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		indentBlock: {
+ * 			classes: [
+ * 				'indent-a', // The first step - smallest indentation.
+ * 				'indent-b',
+ * 				'indent-c',
+ * 				'indent-d',
+ * 				'indent-e' // The last step - biggest indentation.
+ * 			]
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * In the example above only 5 indentation steps will be available.
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface IndentBlockConfig {
+    /**
+     * The size of indentation {@link module:indent/indentconfig~IndentBlockConfig#unit units} for each indentation step.
+     *
+     * @default 40
+     */
+    offset?: number;
+    /**
+     * The unit used for indentation {@link module:indent/indentconfig~IndentBlockConfig#offset}.
+     *
+     * @default 'px'
+     */
+    unit?: string;
+    /**
+     * An optional list of classes to use for indenting the editor content. If not set or set to an empty array, no classes will be used.
+     * The {@link module:indent/indentconfig~IndentBlockConfig#unit `indentBlock.unit`} and
+     * {@link module:indent/indentconfig~IndentBlockConfig#offset `indentBlock.offset`} properties will be used instead.
+     *
+     * @default undefined
+     */
+    classes?: Array<string>;
+}

package/src/indentconfig.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/indentediting.d.ts

@@ -1,26 +1,26 @@
-/**
- * @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/indentediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * The indent editing feature.
- *
- * This plugin registers the `'indent'` and `'outdent'` commands.
- *
- * **Note**: In order for the commands to work, at least one of the compatible features is required. Read more in the
- * {@link module:indent/indent~Indent indent feature} API documentation.
- */
-export default class IndentEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "IndentEditing";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}
+/**
+ * @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/indentediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The indent editing feature.
+ *
+ * This plugin registers the `'indent'` and `'outdent'` commands.
+ *
+ * **Note**: In order for the commands to work, at least one of the compatible features is required. Read more in the
+ * {@link module:indent/indent~Indent indent feature} API documentation.
+ */
+export default class IndentEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "IndentEditing";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/indentediting.js

@@ -1,32 +1,32 @@
-/**
- * @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/indentediting
- */
-import { Plugin, MultiCommand } from 'ckeditor5/src/core';
-/**
- * The indent editing feature.
- *
- * This plugin registers the `'indent'` and `'outdent'` commands.
- *
- * **Note**: In order for the commands to work, at least one of the compatible features is required. Read more in the
- * {@link module:indent/indent~Indent indent feature} API documentation.
- */
-export default class IndentEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'IndentEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        editor.commands.add('indent', new MultiCommand(editor));
-        editor.commands.add('outdent', new MultiCommand(editor));
-    }
-}
+/**
+ * @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/indentediting
+ */
+import { Plugin, MultiCommand } from 'ckeditor5/src/core';
+/**
+ * The indent editing feature.
+ *
+ * This plugin registers the `'indent'` and `'outdent'` commands.
+ *
+ * **Note**: In order for the commands to work, at least one of the compatible features is required. Read more in the
+ * {@link module:indent/indent~Indent indent feature} API documentation.
+ */
+export default class IndentEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'IndentEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        editor.commands.add('indent', new MultiCommand(editor));
+        editor.commands.add('outdent', new MultiCommand(editor));
+    }
+}

package/src/indentui.d.ts

@@ -1,27 +1,27 @@
-/**
- * @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 { Plugin } from 'ckeditor5/src/core';
-/**
- * The indent UI feature.
- *
- * This plugin registers the `'indent'` and `'outdent'` buttons.
- *
- * **Note**: In order for the commands to work, at least one of the compatible features is required. Read more in
- * the {@link module:indent/indent~Indent indent feature} API documentation.
- */
-export default class IndentUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "IndentUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Defines a UI button.
-     */
-    private _defineButton;
-}
+/**
+ * @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 { Plugin } from 'ckeditor5/src/core';
+/**
+ * The indent UI feature.
+ *
+ * This plugin registers the `'indent'` and `'outdent'` buttons.
+ *
+ * **Note**: In order for the commands to work, at least one of the compatible features is required. Read more in
+ * the {@link module:indent/indent~Indent indent feature} API documentation.
+ */
+export default class IndentUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "IndentUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Defines a UI button.
+     */
+    private _defineButton;
+}

package/src/indentui.js

@@ -1,60 +1,60 @@
-/**
- * @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/indentui
- */
-import { ButtonView } from 'ckeditor5/src/ui';
-import { Plugin } from 'ckeditor5/src/core';
-import indentIcon from '../theme/icons/indent.svg';
-import outdentIcon from '../theme/icons/outdent.svg';
-/**
- * The indent UI feature.
- *
- * This plugin registers the `'indent'` and `'outdent'` buttons.
- *
- * **Note**: In order for the commands to work, at least one of the compatible features is required. Read more in
- * the {@link module:indent/indent~Indent indent feature} API documentation.
- */
-export default class IndentUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'IndentUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const locale = editor.locale;
-        const t = editor.t;
-        const localizedIndentIcon = locale.uiLanguageDirection == 'ltr' ? indentIcon : outdentIcon;
-        const localizedOutdentIcon = locale.uiLanguageDirection == 'ltr' ? outdentIcon : indentIcon;
-        this._defineButton('indent', t('Increase indent'), localizedIndentIcon);
-        this._defineButton('outdent', t('Decrease indent'), localizedOutdentIcon);
-    }
-    /**
-     * Defines a UI button.
-     */
-    _defineButton(commandName, label, icon) {
-        const editor = this.editor;
-        editor.ui.componentFactory.add(commandName, locale => {
-            const command = editor.commands.get(commandName);
-            const view = new ButtonView(locale);
-            view.set({
-                label,
-                icon,
-                tooltip: true
-            });
-            view.bind('isEnabled').to(command, 'isEnabled');
-            this.listenTo(view, 'execute', () => {
-                editor.execute(commandName);
-                editor.editing.view.focus();
-            });
-            return view;
-        });
-    }
-}
+/**
+ * @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/indentui
+ */
+import { ButtonView } from 'ckeditor5/src/ui';
+import { Plugin } from 'ckeditor5/src/core';
+import indentIcon from '../theme/icons/indent.svg';
+import outdentIcon from '../theme/icons/outdent.svg';
+/**
+ * The indent UI feature.
+ *
+ * This plugin registers the `'indent'` and `'outdent'` buttons.
+ *
+ * **Note**: In order for the commands to work, at least one of the compatible features is required. Read more in
+ * the {@link module:indent/indent~Indent indent feature} API documentation.
+ */
+export default class IndentUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'IndentUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const locale = editor.locale;
+        const t = editor.t;
+        const localizedIndentIcon = locale.uiLanguageDirection == 'ltr' ? indentIcon : outdentIcon;
+        const localizedOutdentIcon = locale.uiLanguageDirection == 'ltr' ? outdentIcon : indentIcon;
+        this._defineButton('indent', t('Increase indent'), localizedIndentIcon);
+        this._defineButton('outdent', t('Decrease indent'), localizedOutdentIcon);
+    }
+    /**
+     * Defines a UI button.
+     */
+    _defineButton(commandName, label, icon) {
+        const editor = this.editor;
+        editor.ui.componentFactory.add(commandName, locale => {
+            const command = editor.commands.get(commandName);
+            const view = new ButtonView(locale);
+            view.set({
+                label,
+                icon,
+                tooltip: true
+            });
+            view.bind('isEnabled').to(command, 'isEnabled');
+            this.listenTo(view, 'execute', () => {
+                editor.execute(commandName);
+                editor.editing.view.focus();
+            });
+            return view;
+        });
+    }
+}

package/src/index.d.ts

@@ -1,14 +1,14 @@
-/**
- * @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
- */
-export { default as Indent } from './indent';
-export { default as IndentEditing } from './indentediting';
-export { default as IndentUI } from './indentui';
-export { default as IndentBlock } from './indentblock';
-export type { IndentBlockConfig } from './indentconfig';
-export type { default as IndentBlockCommand } from './indentblockcommand';
-import './augmentation';
+/**
+ * @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
+ */
+export { default as Indent } from './indent';
+export { default as IndentEditing } from './indentediting';
+export { default as IndentUI } from './indentui';
+export { default as IndentBlock } from './indentblock';
+export type { IndentBlockConfig } from './indentconfig';
+export type { default as IndentBlockCommand } from './indentblockcommand';
+import './augmentation';

package/src/index.js

@@ -1,12 +1,12 @@
-/**
- * @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
- */
-export { default as Indent } from './indent';
-export { default as IndentEditing } from './indentediting';
-export { default as IndentUI } from './indentui';
-export { default as IndentBlock } from './indentblock';
-import './augmentation';
+/**
+ * @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
+ */
+export { default as Indent } from './indent';
+export { default as IndentEditing } from './indentediting';
+export { default as IndentUI } from './indentui';
+export { default as IndentBlock } from './indentblock';
+import './augmentation';