@ckeditor/ckeditor5-alignment 40.0.0 → 40.2.0

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;
+}

package/src/alignmentediting.js

@@ -1,147 +1,147 @@
-/**
- * @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 } from 'ckeditor5/src/core';
-import AlignmentCommand from './alignmentcommand';
-import { isDefault, isSupported, normalizeAlignmentOptions, supportedOptions } from './utils';
-/**
- * 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() {
-        return 'AlignmentEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        editor.config.define('alignment', {
-            options: supportedOptions.map(option => ({ name: option }))
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const locale = editor.locale;
-        const schema = editor.model.schema;
-        const options = normalizeAlignmentOptions(editor.config.get('alignment.options'));
-        // Filter out unsupported options and those that are redundant, e.g. `left` in LTR / `right` in RTL mode.
-        const optionsToConvert = options.filter(option => isSupported(option.name) && !isDefault(option.name, locale));
-        // Once there is at least one `className` defined, we switch to alignment with classes.
-        const shouldUseClasses = optionsToConvert.some(option => !!option.className);
-        // Allow alignment attribute on all blocks.
-        schema.extend('$block', { allowAttributes: 'alignment' });
-        editor.model.schema.setAttributeProperties('alignment', { isFormatting: true });
-        if (shouldUseClasses) {
-            editor.conversion.attributeToAttribute(buildClassDefinition(optionsToConvert));
-        }
-        else {
-            // Downcast inline styles.
-            editor.conversion.for('downcast').attributeToAttribute(buildDowncastInlineDefinition(optionsToConvert));
-        }
-        const upcastInlineDefinitions = buildUpcastInlineDefinitions(optionsToConvert);
-        // Always upcast from inline styles.
-        for (const definition of upcastInlineDefinitions) {
-            editor.conversion.for('upcast').attributeToAttribute(definition);
-        }
-        const upcastCompatibilityDefinitions = buildUpcastCompatibilityDefinitions(optionsToConvert);
-        // Always upcast from deprecated `align` attribute.
-        for (const definition of upcastCompatibilityDefinitions) {
-            editor.conversion.for('upcast').attributeToAttribute(definition);
-        }
-        editor.commands.add('alignment', new AlignmentCommand(editor));
-    }
-}
-/**
- * Prepare downcast conversion definition for inline alignment styling.
- */
-function buildDowncastInlineDefinition(options) {
-    const view = {};
-    for (const { name } of options) {
-        view[name] = {
-            key: 'style',
-            value: {
-                'text-align': name
-            }
-        };
-    }
-    const definition = {
-        model: {
-            key: 'alignment',
-            values: options.map(option => option.name)
-        },
-        view
-    };
-    return definition;
-}
-/**
- * Prepare upcast definitions for inline alignment styles.
- */
-function buildUpcastInlineDefinitions(options) {
-    const definitions = [];
-    for (const { name } of options) {
-        definitions.push({
-            view: {
-                key: 'style',
-                value: {
-                    'text-align': name
-                }
-            },
-            model: {
-                key: 'alignment',
-                value: name
-            }
-        });
-    }
-    return definitions;
-}
-/**
- * Prepare upcast definitions for deprecated `align` attribute.
- */
-function buildUpcastCompatibilityDefinitions(options) {
-    const definitions = [];
-    for (const { name } of options) {
-        definitions.push({
-            view: {
-                key: 'align',
-                value: name
-            },
-            model: {
-                key: 'alignment',
-                value: name
-            }
-        });
-    }
-    return definitions;
-}
-/**
- * Prepare conversion definitions for upcast and downcast alignment with classes.
- */
-function buildClassDefinition(options) {
-    const view = {};
-    for (const option of options) {
-        view[option.name] = {
-            key: 'class',
-            value: option.className
-        };
-    }
-    const definition = {
-        model: {
-            key: 'alignment',
-            values: options.map(option => option.name)
-        },
-        view
-    };
-    return 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 alignment/alignmentediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import AlignmentCommand from './alignmentcommand';
+import { isDefault, isSupported, normalizeAlignmentOptions, supportedOptions } from './utils';
+/**
+ * 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() {
+        return 'AlignmentEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        editor.config.define('alignment', {
+            options: supportedOptions.map(option => ({ name: option }))
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const locale = editor.locale;
+        const schema = editor.model.schema;
+        const options = normalizeAlignmentOptions(editor.config.get('alignment.options'));
+        // Filter out unsupported options and those that are redundant, e.g. `left` in LTR / `right` in RTL mode.
+        const optionsToConvert = options.filter(option => isSupported(option.name) && !isDefault(option.name, locale));
+        // Once there is at least one `className` defined, we switch to alignment with classes.
+        const shouldUseClasses = optionsToConvert.some(option => !!option.className);
+        // Allow alignment attribute on all blocks.
+        schema.extend('$block', { allowAttributes: 'alignment' });
+        editor.model.schema.setAttributeProperties('alignment', { isFormatting: true });
+        if (shouldUseClasses) {
+            editor.conversion.attributeToAttribute(buildClassDefinition(optionsToConvert));
+        }
+        else {
+            // Downcast inline styles.
+            editor.conversion.for('downcast').attributeToAttribute(buildDowncastInlineDefinition(optionsToConvert));
+        }
+        const upcastInlineDefinitions = buildUpcastInlineDefinitions(optionsToConvert);
+        // Always upcast from inline styles.
+        for (const definition of upcastInlineDefinitions) {
+            editor.conversion.for('upcast').attributeToAttribute(definition);
+        }
+        const upcastCompatibilityDefinitions = buildUpcastCompatibilityDefinitions(optionsToConvert);
+        // Always upcast from deprecated `align` attribute.
+        for (const definition of upcastCompatibilityDefinitions) {
+            editor.conversion.for('upcast').attributeToAttribute(definition);
+        }
+        editor.commands.add('alignment', new AlignmentCommand(editor));
+    }
+}
+/**
+ * Prepare downcast conversion definition for inline alignment styling.
+ */
+function buildDowncastInlineDefinition(options) {
+    const view = {};
+    for (const { name } of options) {
+        view[name] = {
+            key: 'style',
+            value: {
+                'text-align': name
+            }
+        };
+    }
+    const definition = {
+        model: {
+            key: 'alignment',
+            values: options.map(option => option.name)
+        },
+        view
+    };
+    return definition;
+}
+/**
+ * Prepare upcast definitions for inline alignment styles.
+ */
+function buildUpcastInlineDefinitions(options) {
+    const definitions = [];
+    for (const { name } of options) {
+        definitions.push({
+            view: {
+                key: 'style',
+                value: {
+                    'text-align': name
+                }
+            },
+            model: {
+                key: 'alignment',
+                value: name
+            }
+        });
+    }
+    return definitions;
+}
+/**
+ * Prepare upcast definitions for deprecated `align` attribute.
+ */
+function buildUpcastCompatibilityDefinitions(options) {
+    const definitions = [];
+    for (const { name } of options) {
+        definitions.push({
+            view: {
+                key: 'align',
+                value: name
+            },
+            model: {
+                key: 'alignment',
+                value: name
+            }
+        });
+    }
+    return definitions;
+}
+/**
+ * Prepare conversion definitions for upcast and downcast alignment with classes.
+ */
+function buildClassDefinition(options) {
+    const view = {};
+    for (const option of options) {
+        view[option.name] = {
+            key: 'class',
+            value: option.className
+        };
+    }
+    const definition = {
+        model: {
+            key: 'alignment',
+            values: options.map(option => option.name)
+        },
+        view
+    };
+    return definition;
+}

package/src/alignmentui.d.ts

@@ -1,45 +1,45 @@
-/**
- * @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 } from 'ckeditor5/src/core';
-import type { SupportedOption } from './alignmentconfig';
-/**
- * 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(): Record<SupportedOption, string>;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AlignmentUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * 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.
-     */
-    private _addButton;
-}
+/**
+ * @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 } from 'ckeditor5/src/core';
+import type { SupportedOption } from './alignmentconfig';
+/**
+ * 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(): Record<SupportedOption, string>;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "AlignmentUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * 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.
+     */
+    private _addButton;
+}