@ckeditor/ckeditor5-alignment 40.0.0 → 40.2.0

package/src/alignmentui.js

@@ -1,124 +1,124 @@
-/**
- * @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/alignmentui
- */
-import { Plugin, icons } from 'ckeditor5/src/core';
-import { ButtonView, createDropdown, addToolbarToDropdown } from 'ckeditor5/src/ui';
-import { isSupported, normalizeAlignmentOptions } from './utils';
-const iconsMap = new Map([
-    ['left', icons.alignLeft],
-    ['right', icons.alignRight],
-    ['center', icons.alignCenter],
-    ['justify', icons.alignJustify]
-]);
-/**
- * The default alignment UI plugin.
- *
- * It introduces the `'alignment:left'`, `'alignment:right'`, `'alignment:center'` and `'alignment:justify'` buttons
- * and the `'alignment'` dropdown.
- */
-export default class AlignmentUI extends Plugin {
-    /**
-     * Returns the localized option titles provided by the plugin.
-     *
-     * The following localized titles corresponding with
-     * {@link module:alignment/alignmentconfig~AlignmentConfig#options} are available:
-     *
-     * * `'left'`,
-     * * `'right'`,
-     * * `'center'`,
-     * * `'justify'`.
-     *
-     * @readonly
-     */
-    get localizedOptionTitles() {
-        const t = this.editor.t;
-        return {
-            'left': t('Align left'),
-            'right': t('Align right'),
-            'center': t('Align center'),
-            'justify': t('Justify')
-        };
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'AlignmentUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const componentFactory = editor.ui.componentFactory;
-        const t = editor.t;
-        const options = normalizeAlignmentOptions(editor.config.get('alignment.options'));
-        options
-            .map(option => option.name)
-            .filter(isSupported)
-            .forEach(option => this._addButton(option));
-        componentFactory.add('alignment', locale => {
-            const dropdownView = createDropdown(locale);
-            // Add existing alignment buttons to dropdown's toolbar.
-            addToolbarToDropdown(dropdownView, () => options.map(option => componentFactory.create(`alignment:${option.name}`)), {
-                enableActiveItemFocusOnDropdownOpen: true,
-                isVertical: true,
-                ariaLabel: t('Text alignment toolbar')
-            });
-            // Configure dropdown properties an behavior.
-            dropdownView.buttonView.set({
-                label: t('Text alignment'),
-                tooltip: true
-            });
-            dropdownView.extendTemplate({
-                attributes: {
-                    class: 'ck-alignment-dropdown'
-                }
-            });
-            // The default icon depends on the direction of the content.
-            const defaultIcon = locale.contentLanguageDirection === 'rtl' ? iconsMap.get('right') : iconsMap.get('left');
-            const command = editor.commands.get('alignment');
-            // Change icon to reflect current selection's alignment.
-            dropdownView.buttonView.bind('icon').to(command, 'value', value => iconsMap.get(value) || defaultIcon);
-            // Enable button if any of the buttons is enabled.
-            dropdownView.bind('isEnabled').to(command, 'isEnabled');
-            // Focus the editable after executing the command.
-            // Overrides a default behaviour where the focus is moved to the dropdown button (#12125).
-            this.listenTo(dropdownView, 'execute', () => {
-                editor.editing.view.focus();
-            });
-            return dropdownView;
-        });
-    }
-    /**
-     * Helper method for initializing the button and linking it with an appropriate command.
-     *
-     * @param option The name of the alignment option for which the button is added.
-     */
-    _addButton(option) {
-        const editor = this.editor;
-        editor.ui.componentFactory.add(`alignment:${option}`, locale => {
-            const command = editor.commands.get('alignment');
-            const buttonView = new ButtonView(locale);
-            buttonView.set({
-                label: this.localizedOptionTitles[option],
-                icon: iconsMap.get(option),
-                tooltip: true,
-                isToggleable: true
-            });
-            // Bind button model to command.
-            buttonView.bind('isEnabled').to(command);
-            buttonView.bind('isOn').to(command, 'value', value => value === option);
-            // Execute command.
-            this.listenTo(buttonView, 'execute', () => {
-                editor.execute('alignment', { value: option });
-                editor.editing.view.focus();
-            });
-            return buttonView;
-        });
-    }
-}
+/**
+ * @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/alignmentui
+ */
+import { Plugin, icons } from 'ckeditor5/src/core';
+import { ButtonView, createDropdown, addToolbarToDropdown } from 'ckeditor5/src/ui';
+import { isSupported, normalizeAlignmentOptions } from './utils';
+const iconsMap = new Map([
+    ['left', icons.alignLeft],
+    ['right', icons.alignRight],
+    ['center', icons.alignCenter],
+    ['justify', icons.alignJustify]
+]);
+/**
+ * The default alignment UI plugin.
+ *
+ * It introduces the `'alignment:left'`, `'alignment:right'`, `'alignment:center'` and `'alignment:justify'` buttons
+ * and the `'alignment'` dropdown.
+ */
+export default class AlignmentUI extends Plugin {
+    /**
+     * Returns the localized option titles provided by the plugin.
+     *
+     * The following localized titles corresponding with
+     * {@link module:alignment/alignmentconfig~AlignmentConfig#options} are available:
+     *
+     * * `'left'`,
+     * * `'right'`,
+     * * `'center'`,
+     * * `'justify'`.
+     *
+     * @readonly
+     */
+    get localizedOptionTitles() {
+        const t = this.editor.t;
+        return {
+            'left': t('Align left'),
+            'right': t('Align right'),
+            'center': t('Align center'),
+            'justify': t('Justify')
+        };
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'AlignmentUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const componentFactory = editor.ui.componentFactory;
+        const t = editor.t;
+        const options = normalizeAlignmentOptions(editor.config.get('alignment.options'));
+        options
+            .map(option => option.name)
+            .filter(isSupported)
+            .forEach(option => this._addButton(option));
+        componentFactory.add('alignment', locale => {
+            const dropdownView = createDropdown(locale);
+            // Add existing alignment buttons to dropdown's toolbar.
+            addToolbarToDropdown(dropdownView, () => options.map(option => componentFactory.create(`alignment:${option.name}`)), {
+                enableActiveItemFocusOnDropdownOpen: true,
+                isVertical: true,
+                ariaLabel: t('Text alignment toolbar')
+            });
+            // Configure dropdown properties an behavior.
+            dropdownView.buttonView.set({
+                label: t('Text alignment'),
+                tooltip: true
+            });
+            dropdownView.extendTemplate({
+                attributes: {
+                    class: 'ck-alignment-dropdown'
+                }
+            });
+            // The default icon depends on the direction of the content.
+            const defaultIcon = locale.contentLanguageDirection === 'rtl' ? iconsMap.get('right') : iconsMap.get('left');
+            const command = editor.commands.get('alignment');
+            // Change icon to reflect current selection's alignment.
+            dropdownView.buttonView.bind('icon').to(command, 'value', value => iconsMap.get(value) || defaultIcon);
+            // Enable button if any of the buttons is enabled.
+            dropdownView.bind('isEnabled').to(command, 'isEnabled');
+            // Focus the editable after executing the command.
+            // Overrides a default behaviour where the focus is moved to the dropdown button (#12125).
+            this.listenTo(dropdownView, 'execute', () => {
+                editor.editing.view.focus();
+            });
+            return dropdownView;
+        });
+    }
+    /**
+     * Helper method for initializing the button and linking it with an appropriate command.
+     *
+     * @param option The name of the alignment option for which the button is added.
+     */
+    _addButton(option) {
+        const editor = this.editor;
+        editor.ui.componentFactory.add(`alignment:${option}`, locale => {
+            const command = editor.commands.get('alignment');
+            const buttonView = new ButtonView(locale);
+            buttonView.set({
+                label: this.localizedOptionTitles[option],
+                icon: iconsMap.get(option),
+                tooltip: true,
+                isToggleable: true
+            });
+            // Bind button model to command.
+            buttonView.bind('isEnabled').to(command);
+            buttonView.bind('isOn').to(command, 'value', value => value === option);
+            // Execute command.
+            this.listenTo(buttonView, 'execute', () => {
+                editor.execute('alignment', { value: option });
+                editor.editing.view.focus();
+            });
+            return buttonView;
+        });
+    }
+}

package/src/augmentation.d.ts

@@ -1,23 +1,23 @@
-/**
- * @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 { Alignment, AlignmentEditing, AlignmentUI, AlignmentCommand, AlignmentConfig } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:alignment/alignment~Alignment alignment feature}.
-         *
-         * Read more in {@link module:alignment/alignmentconfig~AlignmentConfig}.
-         */
-        alignment?: AlignmentConfig;
-    }
-    interface PluginsMap {
-        [Alignment.pluginName]: Alignment;
-        [AlignmentUI.pluginName]: AlignmentUI;
-        [AlignmentEditing.pluginName]: AlignmentEditing;
-    }
-    interface CommandsMap {
-        alignment: AlignmentCommand;
-    }
-}
+/**
+ * @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 { Alignment, AlignmentEditing, AlignmentUI, AlignmentCommand, AlignmentConfig } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:alignment/alignment~Alignment alignment feature}.
+         *
+         * Read more in {@link module:alignment/alignmentconfig~AlignmentConfig}.
+         */
+        alignment?: AlignmentConfig;
+    }
+    interface PluginsMap {
+        [Alignment.pluginName]: Alignment;
+        [AlignmentUI.pluginName]: AlignmentUI;
+        [AlignmentEditing.pluginName]: AlignmentEditing;
+    }
+    interface CommandsMap {
+        alignment: AlignmentCommand;
+    }
+}

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/index.d.ts

@@ -1,13 +1,13 @@
-/**
- * @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
- */
-export { default as Alignment } from './alignment';
-export { default as AlignmentEditing } from './alignmentediting';
-export { default as AlignmentUI } from './alignmentui';
-export type { default as AlignmentCommand } from './alignmentcommand';
-export type { AlignmentConfig } from './alignmentconfig';
-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 alignment
+ */
+export { default as Alignment } from './alignment';
+export { default as AlignmentEditing } from './alignmentediting';
+export { default as AlignmentUI } from './alignmentui';
+export type { default as AlignmentCommand } from './alignmentcommand';
+export type { AlignmentConfig } from './alignmentconfig';
+import './augmentation';

package/src/index.js

@@ -1,11 +1,11 @@
-/**
- * @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
- */
-export { default as Alignment } from './alignment';
-export { default as AlignmentEditing } from './alignmentediting';
-export { default as AlignmentUI } from './alignmentui';
-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 alignment
+ */
+export { default as Alignment } from './alignment';
+export { default as AlignmentEditing } from './alignmentediting';
+export { default as AlignmentUI } from './alignmentui';
+import './augmentation';

package/src/utils.d.ts

@@ -1,39 +1,39 @@
-/**
- * @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 Locale } from 'ckeditor5/src/utils';
-import type { AlignmentFormat, SupportedOption } from './alignmentconfig';
-/**
- * @module alignment/utils
- */
-/**
- * The list of supported alignment options:
- *
- * * `'left'`,
- * * `'right'`,
- * * `'center'`,
- * * `'justify'`
- */
-export declare const supportedOptions: ReadonlyArray<SupportedOption>;
-/**
- * Checks whether the passed option is supported by {@link module:alignment/alignmentediting~AlignmentEditing}.
- *
- * @param option The option value to check.
- */
-export declare function isSupported(option: string): boolean;
-/**
- * Checks whether alignment is the default one considering the direction
- * of the editor content.
- *
- * @param alignment The name of the alignment to check.
- * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
- */
-export declare function isDefault(alignment: string, locale: Locale): boolean;
-/**
- * Brings the configuration to the common form, an array of objects.
- *
- * @param configuredOptions Alignment plugin configuration.
- * @returns Normalized object holding the configuration.
- */
-export declare function normalizeAlignmentOptions(configuredOptions: Array<string | AlignmentFormat>): Array<AlignmentFormat>;
+/**
+ * @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 Locale } from 'ckeditor5/src/utils';
+import type { AlignmentFormat, SupportedOption } from './alignmentconfig';
+/**
+ * @module alignment/utils
+ */
+/**
+ * The list of supported alignment options:
+ *
+ * * `'left'`,
+ * * `'right'`,
+ * * `'center'`,
+ * * `'justify'`
+ */
+export declare const supportedOptions: ReadonlyArray<SupportedOption>;
+/**
+ * Checks whether the passed option is supported by {@link module:alignment/alignmentediting~AlignmentEditing}.
+ *
+ * @param option The option value to check.
+ */
+export declare function isSupported(option: string): boolean;
+/**
+ * Checks whether alignment is the default one considering the direction
+ * of the editor content.
+ *
+ * @param alignment The name of the alignment to check.
+ * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
+ */
+export declare function isDefault(alignment: string, locale: Locale): boolean;
+/**
+ * Brings the configuration to the common form, an array of objects.
+ *
+ * @param configuredOptions Alignment plugin configuration.
+ * @returns Normalized object holding the configuration.
+ */
+export declare function normalizeAlignmentOptions(configuredOptions: Array<string | AlignmentFormat>): Array<AlignmentFormat>;