@ckeditor/ckeditor5-alignment 40.0.0 → 40.1.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor&nbsp;5 text alignment feature** – https://github.com/ckeditor/ckeditor5-alignment <br>
-Copyright (c) 2003-2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
+Copyright (c) 2003–2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
 
@@ -14,4 +14,4 @@ Where not otherwise indicated, all CKEditor content is authored by CKSource engi
 Trademarks
 ----------
 
-**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
+**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks, or service marks of their respective holders.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-alignment",
-  "version": "40.0.0",
+  "version": "40.1.0",
   "description": "Text alignment feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "40.0.0"
+    "ckeditor5": "40.1.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",

package/src/alignment.d.ts

@@ -1,29 +1,29 @@
-/**
- * @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 alignment/alignment
- */
-import { Plugin } from 'ckeditor5/src/core';
-import AlignmentEditing from './alignmentediting';
-import AlignmentUI from './alignmentui';
-/**
- * The text alignment plugin.
- *
- * For a detailed overview, check the {@glink features/text-alignment Text alignment} feature guide
- * and the {@glink api/alignment package page}.
- *
- * This is a "glue" plugin which loads the {@link module:alignment/alignmentediting~AlignmentEditing} and
- * {@link module:alignment/alignmentui~AlignmentUI} plugins.
- */
-export default class Alignment extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof AlignmentEditing, typeof AlignmentUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Alignment";
-}
+/**
+ * @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 alignment/alignment
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import AlignmentEditing from './alignmentediting';
+import AlignmentUI from './alignmentui';
+/**
+ * The text alignment plugin.
+ *
+ * For a detailed overview, check the {@glink features/text-alignment Text alignment} feature guide
+ * and the {@glink api/alignment package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:alignment/alignmentediting~AlignmentEditing} and
+ * {@link module:alignment/alignmentui~AlignmentUI} plugins.
+ */
+export default class Alignment extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof AlignmentEditing, typeof AlignmentUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Alignment";
+}

package/src/alignment.js

@@ -1,33 +1,33 @@
-/**
- * @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 alignment/alignment
- */
-import { Plugin } from 'ckeditor5/src/core';
-import AlignmentEditing from './alignmentediting';
-import AlignmentUI from './alignmentui';
-/**
- * The text alignment plugin.
- *
- * For a detailed overview, check the {@glink features/text-alignment Text alignment} feature guide
- * and the {@glink api/alignment package page}.
- *
- * This is a "glue" plugin which loads the {@link module:alignment/alignmentediting~AlignmentEditing} and
- * {@link module:alignment/alignmentui~AlignmentUI} plugins.
- */
-export default class Alignment extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [AlignmentEditing, AlignmentUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Alignment';
-    }
-}
+/**
+ * @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 alignment/alignment
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import AlignmentEditing from './alignmentediting';
+import AlignmentUI from './alignmentui';
+/**
+ * The text alignment plugin.
+ *
+ * For a detailed overview, check the {@glink features/text-alignment Text alignment} feature guide
+ * and the {@glink api/alignment package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:alignment/alignmentediting~AlignmentEditing} and
+ * {@link module:alignment/alignmentui~AlignmentUI} plugins.
+ */
+export default class Alignment extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [AlignmentEditing, AlignmentUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Alignment';
+    }
+}

package/src/alignmentcommand.d.ts

@@ -1,43 +1,43 @@
-/**
- * @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 alignment/alignmentcommand
- */
-import { Command } from 'ckeditor5/src/core';
-import type { SupportedOption } from './alignmentconfig';
-/**
- * The alignment command plugin.
- */
-export default class AlignmentCommand extends Command {
-    /**
-     * A value of the current block's alignment.
-     *
-     * @observable
-     * @readonly
-     */
-    value: SupportedOption;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command. Applies the alignment `value` to the selected blocks.
-     * If no `value` is passed, the `value` is the default one or it is equal to the currently selected block's alignment attribute,
-     * the command will remove the attribute from the selected blocks.
-     *
-     * @param options Options for the executed command.
-     * @param options.value The value to apply.
-     * @fires execute
-     */
-    execute(options?: {
-        value?: SupportedOption;
-    }): void;
-    /**
-     * Checks whether a block can have alignment set.
-     *
-     * @param block The block to be checked.
-     */
-    private _canBeAligned;
-}
+/**
+ * @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 alignment/alignmentcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+import type { SupportedOption } from './alignmentconfig';
+/**
+ * The alignment command plugin.
+ */
+export default class AlignmentCommand extends Command {
+    /**
+     * A value of the current block's alignment.
+     *
+     * @observable
+     * @readonly
+     */
+    value: SupportedOption;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command. Applies the alignment `value` to the selected blocks.
+     * If no `value` is passed, the `value` is the default one or it is equal to the currently selected block's alignment attribute,
+     * the command will remove the attribute from the selected blocks.
+     *
+     * @param options Options for the executed command.
+     * @param options.value The value to apply.
+     * @fires execute
+     */
+    execute(options?: {
+        value?: SupportedOption;
+    }): void;
+    /**
+     * Checks whether a block can have alignment set.
+     *
+     * @param block The block to be checked.
+     */
+    private _canBeAligned;
+}

package/src/alignmentcommand.js

@@ -1,88 +1,88 @@
-/**
- * @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 alignment/alignmentcommand
- */
-import { Command } from 'ckeditor5/src/core';
-import { first } from 'ckeditor5/src/utils';
-import { isDefault } from './utils';
-const ALIGNMENT = 'alignment';
-/**
- * The alignment command plugin.
- */
-export default class AlignmentCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const editor = this.editor;
-        const locale = editor.locale;
-        const firstBlock = first(this.editor.model.document.selection.getSelectedBlocks());
-        // As first check whether to enable or disable the command as the value will always be false if the command cannot be enabled.
-        this.isEnabled = Boolean(firstBlock) && this._canBeAligned(firstBlock);
-        if (this.isEnabled && firstBlock.hasAttribute('alignment')) {
-            this.value = firstBlock.getAttribute('alignment');
-        }
-        else {
-            this.value = locale.contentLanguageDirection === 'rtl' ? 'right' : 'left';
-        }
-    }
-    /**
-     * Executes the command. Applies the alignment `value` to the selected blocks.
-     * If no `value` is passed, the `value` is the default one or it is equal to the currently selected block's alignment attribute,
-     * the command will remove the attribute from the selected blocks.
-     *
-     * @param options Options for the executed command.
-     * @param options.value The value to apply.
-     * @fires execute
-     */
-    execute(options = {}) {
-        const editor = this.editor;
-        const locale = editor.locale;
-        const model = editor.model;
-        const doc = model.document;
-        const value = options.value;
-        model.change(writer => {
-            // Get only those blocks from selected that can have alignment set
-            const blocks = Array.from(doc.selection.getSelectedBlocks()).filter(block => this._canBeAligned(block));
-            const currentAlignment = blocks[0].getAttribute('alignment');
-            // Remove alignment attribute if current alignment is:
-            // - default (should not be stored in model as it will bloat model data)
-            // - equal to currently set
-            // - or no value is passed - denotes default alignment.
-            const removeAlignment = isDefault(value, locale) || currentAlignment === value || !value;
-            if (removeAlignment) {
-                removeAlignmentFromSelection(blocks, writer);
-            }
-            else {
-                setAlignmentOnSelection(blocks, writer, value);
-            }
-        });
-    }
-    /**
-     * Checks whether a block can have alignment set.
-     *
-     * @param block The block to be checked.
-     */
-    _canBeAligned(block) {
-        return this.editor.model.schema.checkAttribute(block, ALIGNMENT);
-    }
-}
-/**
- * Removes the alignment attribute from blocks.
- */
-function removeAlignmentFromSelection(blocks, writer) {
-    for (const block of blocks) {
-        writer.removeAttribute(ALIGNMENT, block);
-    }
-}
-/**
- * Sets the alignment attribute on blocks.
- */
-function setAlignmentOnSelection(blocks, writer, alignment) {
-    for (const block of blocks) {
-        writer.setAttribute(ALIGNMENT, alignment, block);
-    }
-}
+/**
+ * @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 alignment/alignmentcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+import { first } from 'ckeditor5/src/utils';
+import { isDefault } from './utils';
+const ALIGNMENT = 'alignment';
+/**
+ * The alignment command plugin.
+ */
+export default class AlignmentCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const editor = this.editor;
+        const locale = editor.locale;
+        const firstBlock = first(this.editor.model.document.selection.getSelectedBlocks());
+        // As first check whether to enable or disable the command as the value will always be false if the command cannot be enabled.
+        this.isEnabled = Boolean(firstBlock) && this._canBeAligned(firstBlock);
+        if (this.isEnabled && firstBlock.hasAttribute('alignment')) {
+            this.value = firstBlock.getAttribute('alignment');
+        }
+        else {
+            this.value = locale.contentLanguageDirection === 'rtl' ? 'right' : 'left';
+        }
+    }
+    /**
+     * Executes the command. Applies the alignment `value` to the selected blocks.
+     * If no `value` is passed, the `value` is the default one or it is equal to the currently selected block's alignment attribute,
+     * the command will remove the attribute from the selected blocks.
+     *
+     * @param options Options for the executed command.
+     * @param options.value The value to apply.
+     * @fires execute
+     */
+    execute(options = {}) {
+        const editor = this.editor;
+        const locale = editor.locale;
+        const model = editor.model;
+        const doc = model.document;
+        const value = options.value;
+        model.change(writer => {
+            // Get only those blocks from selected that can have alignment set
+            const blocks = Array.from(doc.selection.getSelectedBlocks()).filter(block => this._canBeAligned(block));
+            const currentAlignment = blocks[0].getAttribute('alignment');
+            // Remove alignment attribute if current alignment is:
+            // - default (should not be stored in model as it will bloat model data)
+            // - equal to currently set
+            // - or no value is passed - denotes default alignment.
+            const removeAlignment = isDefault(value, locale) || currentAlignment === value || !value;
+            if (removeAlignment) {
+                removeAlignmentFromSelection(blocks, writer);
+            }
+            else {
+                setAlignmentOnSelection(blocks, writer, value);
+            }
+        });
+    }
+    /**
+     * Checks whether a block can have alignment set.
+     *
+     * @param block The block to be checked.
+     */
+    _canBeAligned(block) {
+        return this.editor.model.schema.checkAttribute(block, ALIGNMENT);
+    }
+}
+/**
+ * Removes the alignment attribute from blocks.
+ */
+function removeAlignmentFromSelection(blocks, writer) {
+    for (const block of blocks) {
+        writer.removeAttribute(ALIGNMENT, block);
+    }
+}
+/**
+ * Sets the alignment attribute on blocks.
+ */
+function setAlignmentOnSelection(blocks, writer, alignment) {
+    for (const block of blocks) {
+        writer.setAttribute(ALIGNMENT, alignment, block);
+    }
+}

package/src/alignmentconfig.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 alignment/alignmentconfig
- */
-/**
- * The configuration of the {@link module:alignment/alignment~Alignment alignment feature}.
- *
- * ```ts
- * ClassicEditor
- *   .create( editorElement, {
- *     alignment: {
- *       options: [ 'left', 'right' ]
- *     }
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
- */
-export interface AlignmentConfig {
-    options?: Array<SupportedOption | AlignmentFormat>;
-}
-/**
- * Available alignment options.
- *
- * The available options are: `'left'`, `'right'`, `'center'` and `'justify'`. Other values are ignored.
- *
- * **Note:** It is recommended to always use `'left'` or `'right'` as these are default values which the user should
- * normally be able to choose depending on the
- * {@glink features/ui-language#setting-the-language-of-the-content language of the editor content}.
- *
- * ```ts
- * ClassicEditor
- *   .create( editorElement, {
- *     alignment: {
- *       options: [ 'left', 'right' ]
- *     }
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- *
- * By default the alignment is set inline using the `text-align` CSS property. To further customize the alignment,
- * you can provide names of classes for each alignment option using the `className` property.
- *
- * **Note:** Once you define the `className` property for one option, you need to specify it for all other options.
- *
- * ```ts
- * ClassicEditor
- *   .create( editorElement, {
- *     alignment: {
- *       options: [
- *         { name: 'left', className: 'my-align-left' },
- *         { name: 'right', className: 'my-align-right' }
- *       ]
- *     }
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- *
- * See the demo of {@glink features/text-alignment#configuring-alignment-options custom alignment options}.
- */
-export type AlignmentFormat = {
-    name: SupportedOption;
-    className?: string;
-};
-export type SupportedOption = 'left' | 'right' | 'center' | 'justify';
+/**
+ * @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 alignment/alignmentconfig
+ */
+/**
+ * The configuration of the {@link module:alignment/alignment~Alignment alignment feature}.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( editorElement, {
+ *     alignment: {
+ *       options: [ 'left', 'right' ]
+ *     }
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
+ */
+export interface AlignmentConfig {
+    options?: Array<SupportedOption | AlignmentFormat>;
+}
+/**
+ * Available alignment options.
+ *
+ * The available options are: `'left'`, `'right'`, `'center'` and `'justify'`. Other values are ignored.
+ *
+ * **Note:** It is recommended to always use `'left'` or `'right'` as these are default values which the user should
+ * normally be able to choose depending on the
+ * {@glink features/ui-language#setting-the-language-of-the-content language of the editor content}.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( editorElement, {
+ *     alignment: {
+ *       options: [ 'left', 'right' ]
+ *     }
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ *
+ * By default the alignment is set inline using the `text-align` CSS property. To further customize the alignment,
+ * you can provide names of classes for each alignment option using the `className` property.
+ *
+ * **Note:** Once you define the `className` property for one option, you need to specify it for all other options.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( editorElement, {
+ *     alignment: {
+ *       options: [
+ *         { name: 'left', className: 'my-align-left' },
+ *         { name: 'right', className: 'my-align-right' }
+ *       ]
+ *     }
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ *
+ * See the demo of {@glink features/text-alignment#configuring-alignment-options custom alignment options}.
+ */
+export type AlignmentFormat = {
+    name: SupportedOption;
+    className?: string;
+};
+export type SupportedOption = 'left' | 'right' | 'center' | 'justify';

package/src/alignmentconfig.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/alignmentediting.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 alignment/alignmentediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-/**
- * The alignment editing feature. It introduces the {@link module:alignment/alignmentcommand~AlignmentCommand command} and adds
- * the `alignment` attribute for block elements in the {@link module:engine/model/model~Model model}.
- */
-export default class AlignmentEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AlignmentEditing";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @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 alignment/alignmentediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+/**
+ * The alignment editing feature. It introduces the {@link module:alignment/alignmentcommand~AlignmentCommand command} and adds
+ * the `alignment` attribute for block elements in the {@link module:engine/model/model~Model model}.
+ */
+export default class AlignmentEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "AlignmentEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}