@ckeditor/ckeditor5-language 39.0.1 → 40.0.0

package/src/textpartlanguageconfig.d.ts

@@ -1,25 +1,25 @@
-/**
- * @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 language/textpartlanguageconfig
- */
-import type { LanguageDirection } from 'ckeditor5/src/utils';
-/**
- * The text part language feature option descriptor.
- */
-export interface TextPartLanguageOption {
-    /**
-     * The user-readable title of the option.
-     */
-    title: string;
-    /**
-     * The language code in the ISO 639 format.
-     */
-    languageCode: string;
-    /**
-     * The language text direction. Automatically detected if omitted.
-     */
-    textDirection?: LanguageDirection;
-}
+/**
+ * @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 language/textpartlanguageconfig
+ */
+import type { LanguageDirection } from 'ckeditor5/src/utils';
+/**
+ * The text part language feature option descriptor.
+ */
+export interface TextPartLanguageOption {
+    /**
+     * The user-readable title of the option.
+     */
+    title: string;
+    /**
+     * The language code in the ISO 639 format.
+     */
+    languageCode: string;
+    /**
+     * The language text direction. Automatically detected if omitted.
+     */
+    textDirection?: LanguageDirection;
+}

package/src/textpartlanguageconfig.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/textpartlanguageediting.d.ts

@@ -1,28 +1,28 @@
-/**
- * @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, type Editor } from 'ckeditor5/src/core';
-/**
- * The text part language editing.
- *
- * Introduces the `'textPartLanguage'` command and the `'language'` model element attribute.
- */
-export default class TextPartLanguageEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TextPartLanguageEditing";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @private
-     */
-    private _defineConverters;
-}
+/**
+ * @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, type Editor } from 'ckeditor5/src/core';
+/**
+ * The text part language editing.
+ *
+ * Introduces the `'textPartLanguage'` command and the `'language'` model element attribute.
+ */
+export default class TextPartLanguageEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TextPartLanguageEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @private
+     */
+    private _defineConverters;
+}

package/src/textpartlanguageediting.js

@@ -1,84 +1,84 @@
-/**
- * @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';
-import TextPartLanguageCommand from './textpartlanguagecommand';
-import { stringifyLanguageAttribute, parseLanguageAttribute } from './utils';
-/**
- * The text part language editing.
- *
- * Introduces the `'textPartLanguage'` command and the `'language'` model element attribute.
- */
-export default class TextPartLanguageEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'TextPartLanguageEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        // Text part language options are only used to ensure that the feature works by default.
-        // In the real usage it should be reconfigured by a developer. We are not providing
-        // translations for `title` properties on purpose, as it's only an example configuration.
-        editor.config.define('language', {
-            textPartLanguage: [
-                { title: 'Arabic', languageCode: 'ar' },
-                { title: 'French', languageCode: 'fr' },
-                { title: 'Spanish', languageCode: 'es' }
-            ]
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        editor.model.schema.extend('$text', { allowAttributes: 'language' });
-        editor.model.schema.setAttributeProperties('language', {
-            copyOnEnter: true
-        });
-        this._defineConverters();
-        editor.commands.add('textPartLanguage', new TextPartLanguageCommand(editor));
-    }
-    /**
-     * @private
-     */
-    _defineConverters() {
-        const conversion = this.editor.conversion;
-        conversion.for('upcast').elementToAttribute({
-            model: {
-                key: 'language',
-                value: (viewElement) => {
-                    const languageCode = viewElement.getAttribute('lang');
-                    const textDirection = viewElement.getAttribute('dir');
-                    return stringifyLanguageAttribute(languageCode, textDirection);
-                }
-            },
-            view: {
-                name: 'span',
-                attributes: { lang: /[\s\S]+/ }
-            }
-        });
-        conversion.for('downcast').attributeToElement({
-            model: 'language',
-            view: (attributeValue, { writer }, data) => {
-                if (!attributeValue) {
-                    return;
-                }
-                if (!data.item.is('$textProxy') && !data.item.is('documentSelection')) {
-                    return;
-                }
-                const { languageCode, textDirection } = parseLanguageAttribute(attributeValue);
-                return writer.createAttributeElement('span', {
-                    lang: languageCode,
-                    dir: textDirection
-                });
-            }
-        });
-    }
-}
+/**
+ * @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';
+import TextPartLanguageCommand from './textpartlanguagecommand';
+import { stringifyLanguageAttribute, parseLanguageAttribute } from './utils';
+/**
+ * The text part language editing.
+ *
+ * Introduces the `'textPartLanguage'` command and the `'language'` model element attribute.
+ */
+export default class TextPartLanguageEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TextPartLanguageEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        // Text part language options are only used to ensure that the feature works by default.
+        // In the real usage it should be reconfigured by a developer. We are not providing
+        // translations for `title` properties on purpose, as it's only an example configuration.
+        editor.config.define('language', {
+            textPartLanguage: [
+                { title: 'Arabic', languageCode: 'ar' },
+                { title: 'French', languageCode: 'fr' },
+                { title: 'Spanish', languageCode: 'es' }
+            ]
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        editor.model.schema.extend('$text', { allowAttributes: 'language' });
+        editor.model.schema.setAttributeProperties('language', {
+            copyOnEnter: true
+        });
+        this._defineConverters();
+        editor.commands.add('textPartLanguage', new TextPartLanguageCommand(editor));
+    }
+    /**
+     * @private
+     */
+    _defineConverters() {
+        const conversion = this.editor.conversion;
+        conversion.for('upcast').elementToAttribute({
+            model: {
+                key: 'language',
+                value: (viewElement) => {
+                    const languageCode = viewElement.getAttribute('lang');
+                    const textDirection = viewElement.getAttribute('dir');
+                    return stringifyLanguageAttribute(languageCode, textDirection);
+                }
+            },
+            view: {
+                name: 'span',
+                attributes: { lang: /[\s\S]+/ }
+            }
+        });
+        conversion.for('downcast').attributeToElement({
+            model: 'language',
+            view: (attributeValue, { writer }, data) => {
+                if (!attributeValue) {
+                    return;
+                }
+                if (!data.item.is('$textProxy') && !data.item.is('documentSelection')) {
+                    return;
+                }
+                const { languageCode, textDirection } = parseLanguageAttribute(attributeValue);
+                return writer.createAttributeElement('span', {
+                    lang: languageCode,
+                    dir: textDirection
+                });
+            }
+        });
+    }
+}

package/src/textpartlanguageui.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
- */
-/**
- * @module language/textpartlanguageui
- */
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * The text part language UI plugin.
- *
- * It introduces the `'language'` dropdown.
- */
-export default class TextPartLanguageUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TextPartLanguageUI";
-    /**
-     * @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 language/textpartlanguageui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The text part language UI plugin.
+ *
+ * It introduces the `'language'` dropdown.
+ */
+export default class TextPartLanguageUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TextPartLanguageUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/textpartlanguageui.js

@@ -1,101 +1,101 @@
-/**
- * @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 language/textpartlanguageui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Model, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
-import { Collection } from 'ckeditor5/src/utils';
-import { stringifyLanguageAttribute } from './utils';
-/**
- * The text part language UI plugin.
- *
- * It introduces the `'language'` dropdown.
- */
-export default class TextPartLanguageUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'TextPartLanguageUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const t = editor.t;
-        const options = editor.config.get('language.textPartLanguage');
-        const defaultTitle = t('Choose language');
-        const removeTitle = t('Remove language');
-        const accessibleLabel = t('Language');
-        // Register UI component.
-        editor.ui.componentFactory.add('textPartLanguage', locale => {
-            const itemDefinitions = new Collection();
-            const titles = {};
-            const languageCommand = editor.commands.get('textPartLanguage');
-            // Item definition with false `languageCode` will behave as remove lang button.
-            itemDefinitions.add({
-                type: 'button',
-                model: new Model({
-                    label: removeTitle,
-                    languageCode: false,
-                    withText: true
-                })
-            });
-            itemDefinitions.add({
-                type: 'separator'
-            });
-            for (const option of options) {
-                const def = {
-                    type: 'button',
-                    model: new Model({
-                        label: option.title,
-                        languageCode: option.languageCode,
-                        role: 'menuitemradio',
-                        textDirection: option.textDirection,
-                        withText: true
-                    })
-                };
-                const language = stringifyLanguageAttribute(option.languageCode, option.textDirection);
-                def.model.bind('isOn').to(languageCommand, 'value', value => value === language);
-                itemDefinitions.add(def);
-                titles[language] = option.title;
-            }
-            const dropdownView = createDropdown(locale);
-            addListToDropdown(dropdownView, itemDefinitions, {
-                ariaLabel: accessibleLabel,
-                role: 'menu'
-            });
-            dropdownView.buttonView.set({
-                ariaLabel: accessibleLabel,
-                ariaLabelledBy: undefined,
-                isOn: false,
-                withText: true,
-                tooltip: accessibleLabel
-            });
-            dropdownView.extendTemplate({
-                attributes: {
-                    class: [
-                        'ck-text-fragment-language-dropdown'
-                    ]
-                }
-            });
-            dropdownView.bind('isEnabled').to(languageCommand, 'isEnabled');
-            dropdownView.buttonView.bind('label').to(languageCommand, 'value', value => {
-                return (value && titles[value]) || defaultTitle;
-            });
-            // Execute command when an item from the dropdown is selected.
-            this.listenTo(dropdownView, 'execute', evt => {
-                languageCommand.execute({
-                    languageCode: evt.source.languageCode,
-                    textDirection: evt.source.textDirection
-                });
-                editor.editing.view.focus();
-            });
-            return dropdownView;
-        });
-    }
-}
+/**
+ * @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 language/textpartlanguageui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Model, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
+import { Collection } from 'ckeditor5/src/utils';
+import { stringifyLanguageAttribute } from './utils';
+/**
+ * The text part language UI plugin.
+ *
+ * It introduces the `'language'` dropdown.
+ */
+export default class TextPartLanguageUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TextPartLanguageUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        const options = editor.config.get('language.textPartLanguage');
+        const defaultTitle = t('Choose language');
+        const removeTitle = t('Remove language');
+        const accessibleLabel = t('Language');
+        // Register UI component.
+        editor.ui.componentFactory.add('textPartLanguage', locale => {
+            const itemDefinitions = new Collection();
+            const titles = {};
+            const languageCommand = editor.commands.get('textPartLanguage');
+            // Item definition with false `languageCode` will behave as remove lang button.
+            itemDefinitions.add({
+                type: 'button',
+                model: new Model({
+                    label: removeTitle,
+                    languageCode: false,
+                    withText: true
+                })
+            });
+            itemDefinitions.add({
+                type: 'separator'
+            });
+            for (const option of options) {
+                const def = {
+                    type: 'button',
+                    model: new Model({
+                        label: option.title,
+                        languageCode: option.languageCode,
+                        role: 'menuitemradio',
+                        textDirection: option.textDirection,
+                        withText: true
+                    })
+                };
+                const language = stringifyLanguageAttribute(option.languageCode, option.textDirection);
+                def.model.bind('isOn').to(languageCommand, 'value', value => value === language);
+                itemDefinitions.add(def);
+                titles[language] = option.title;
+            }
+            const dropdownView = createDropdown(locale);
+            addListToDropdown(dropdownView, itemDefinitions, {
+                ariaLabel: accessibleLabel,
+                role: 'menu'
+            });
+            dropdownView.buttonView.set({
+                ariaLabel: accessibleLabel,
+                ariaLabelledBy: undefined,
+                isOn: false,
+                withText: true,
+                tooltip: accessibleLabel
+            });
+            dropdownView.extendTemplate({
+                attributes: {
+                    class: [
+                        'ck-text-fragment-language-dropdown'
+                    ]
+                }
+            });
+            dropdownView.bind('isEnabled').to(languageCommand, 'isEnabled');
+            dropdownView.buttonView.bind('label').to(languageCommand, 'value', value => {
+                return (value && titles[value]) || defaultTitle;
+            });
+            // Execute command when an item from the dropdown is selected.
+            this.listenTo(dropdownView, 'execute', evt => {
+                languageCommand.execute({
+                    languageCode: evt.source.languageCode,
+                    textDirection: evt.source.textDirection
+                });
+                editor.editing.view.focus();
+            });
+            return dropdownView;
+        });
+    }
+}

package/src/utils.d.ts

@@ -1,40 +1,40 @@
-/**
- * @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 language/utils
- */
-import { type LanguageDirection } from 'ckeditor5/src/utils';
-/**
- * Returns the language attribute value in a human-readable text format:
- *
- * ```
- * <languageCode>:<textDirection>
- * ```
- *
- * * `languageCode` - The language code used for the `lang` attribute in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
- * * `textDirection` - One of the following values: `rtl` or `ltr`, indicating the reading direction of the language.
- *
- * See the {@link module:core/editor/editorconfig~LanguageConfig#textPartLanguage text part language configuration}
- * for more information about language properties.
- *
- * If the `textDirection` argument is omitted, it will be automatically detected based on `languageCode`.
- *
- * @param languageCode The language code in the ISO 639-1 format.
- * @param textDirection The language text direction. Automatically detected if omitted.
- */
-export declare function stringifyLanguageAttribute(languageCode: string, textDirection?: LanguageDirection): string;
-/**
- * Retrieves language properties converted to attribute value by the
- * {@link module:language/utils~stringifyLanguageAttribute stringifyLanguageAttribute} function.
- *
- * @param str The attribute value.
- * @returns The object with properties:
- * * languageCode - The language code in the ISO 639 format.
- * * textDirection - The language text direction.
- */
-export declare function parseLanguageAttribute(str: string): {
-    languageCode: string;
-    textDirection: 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 language/utils
+ */
+import { type LanguageDirection } from 'ckeditor5/src/utils';
+/**
+ * Returns the language attribute value in a human-readable text format:
+ *
+ * ```
+ * <languageCode>:<textDirection>
+ * ```
+ *
+ * * `languageCode` - The language code used for the `lang` attribute in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
+ * * `textDirection` - One of the following values: `rtl` or `ltr`, indicating the reading direction of the language.
+ *
+ * See the {@link module:core/editor/editorconfig~LanguageConfig#textPartLanguage text part language configuration}
+ * for more information about language properties.
+ *
+ * If the `textDirection` argument is omitted, it will be automatically detected based on `languageCode`.
+ *
+ * @param languageCode The language code in the ISO 639-1 format.
+ * @param textDirection The language text direction. Automatically detected if omitted.
+ */
+export declare function stringifyLanguageAttribute(languageCode: string, textDirection?: LanguageDirection): string;
+/**
+ * Retrieves language properties converted to attribute value by the
+ * {@link module:language/utils~stringifyLanguageAttribute stringifyLanguageAttribute} function.
+ *
+ * @param str The attribute value.
+ * @returns The object with properties:
+ * * languageCode - The language code in the ISO 639 format.
+ * * textDirection - The language text direction.
+ */
+export declare function parseLanguageAttribute(str: string): {
+    languageCode: string;
+    textDirection: string;
+};