@ckeditor/ckeditor5-language 39.0.2 → 40.0.0

package/src/textpartlanguagecommand.js

@@ -1,89 +1,89 @@
-/**
- * @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 { Command } from 'ckeditor5/src/core';
-import { stringifyLanguageAttribute } from './utils';
-/**
- * The text part language command plugin.
- */
-export default class TextPartLanguageCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const model = this.editor.model;
-        const doc = model.document;
-        this.value = this._getValueFromFirstAllowedNode();
-        this.isEnabled = model.schema.checkAttributeInSelection(doc.selection, 'language');
-    }
-    /**
-     * Executes the command. Applies the attribute to the selection or removes it from the selection.
-     *
-     * If `languageCode` is set to `false` or a `null` value, it will remove attributes. Otherwise, it will set
-     * the attribute in the `{@link #value value}` format.
-     *
-     * The execution result differs, depending on the {@link module:engine/model/document~Document#selection}:
-     *
-     * * If the selection is on a range, the command applies the attribute to all nodes in that range
-     * (if they are allowed to have this attribute by the {@link module:engine/model/schema~Schema schema}).
-     * * If the selection is collapsed in a non-empty node, the command applies the attribute to the
-     * {@link module:engine/model/document~Document#selection} itself (note that typed characters copy attributes from the selection).
-     * * If the selection is collapsed in an empty node, the command applies the attribute to the parent node of the selection (note
-     * that the selection inherits all attributes from a node if it is in an empty node).
-     *
-     * @fires execute
-     * @param options Command options.
-     * @param options.languageCode The language code to be applied to the model.
-     * @param options.textDirection The language text direction.
-     */
-    execute({ languageCode, textDirection } = {}) {
-        const model = this.editor.model;
-        const doc = model.document;
-        const selection = doc.selection;
-        const value = languageCode ? stringifyLanguageAttribute(languageCode, textDirection) : false;
-        model.change(writer => {
-            if (selection.isCollapsed) {
-                if (value) {
-                    writer.setSelectionAttribute('language', value);
-                }
-                else {
-                    writer.removeSelectionAttribute('language');
-                }
-            }
-            else {
-                const ranges = model.schema.getValidRanges(selection.getRanges(), 'language');
-                for (const range of ranges) {
-                    if (value) {
-                        writer.setAttribute('language', value, range);
-                    }
-                    else {
-                        writer.removeAttribute('language', range);
-                    }
-                }
-            }
-        });
-    }
-    /**
-     * Returns the attribute value of the first node in the selection that allows the attribute.
-     * For a collapsed selection it returns the selection attribute.
-     *
-     * @returns The attribute value.
-     */
-    _getValueFromFirstAllowedNode() {
-        const model = this.editor.model;
-        const schema = model.schema;
-        const selection = model.document.selection;
-        if (selection.isCollapsed) {
-            return selection.getAttribute('language') || false;
-        }
-        for (const range of selection.getRanges()) {
-            for (const item of range.getItems()) {
-                if (schema.checkAttribute(item, 'language')) {
-                    return item.getAttribute('language') || false;
-                }
-            }
-        }
-        return false;
-    }
-}
+/**
+ * @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 { Command } from 'ckeditor5/src/core';
+import { stringifyLanguageAttribute } from './utils';
+/**
+ * The text part language command plugin.
+ */
+export default class TextPartLanguageCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const model = this.editor.model;
+        const doc = model.document;
+        this.value = this._getValueFromFirstAllowedNode();
+        this.isEnabled = model.schema.checkAttributeInSelection(doc.selection, 'language');
+    }
+    /**
+     * Executes the command. Applies the attribute to the selection or removes it from the selection.
+     *
+     * If `languageCode` is set to `false` or a `null` value, it will remove attributes. Otherwise, it will set
+     * the attribute in the `{@link #value value}` format.
+     *
+     * The execution result differs, depending on the {@link module:engine/model/document~Document#selection}:
+     *
+     * * If the selection is on a range, the command applies the attribute to all nodes in that range
+     * (if they are allowed to have this attribute by the {@link module:engine/model/schema~Schema schema}).
+     * * If the selection is collapsed in a non-empty node, the command applies the attribute to the
+     * {@link module:engine/model/document~Document#selection} itself (note that typed characters copy attributes from the selection).
+     * * If the selection is collapsed in an empty node, the command applies the attribute to the parent node of the selection (note
+     * that the selection inherits all attributes from a node if it is in an empty node).
+     *
+     * @fires execute
+     * @param options Command options.
+     * @param options.languageCode The language code to be applied to the model.
+     * @param options.textDirection The language text direction.
+     */
+    execute({ languageCode, textDirection } = {}) {
+        const model = this.editor.model;
+        const doc = model.document;
+        const selection = doc.selection;
+        const value = languageCode ? stringifyLanguageAttribute(languageCode, textDirection) : false;
+        model.change(writer => {
+            if (selection.isCollapsed) {
+                if (value) {
+                    writer.setSelectionAttribute('language', value);
+                }
+                else {
+                    writer.removeSelectionAttribute('language');
+                }
+            }
+            else {
+                const ranges = model.schema.getValidRanges(selection.getRanges(), 'language');
+                for (const range of ranges) {
+                    if (value) {
+                        writer.setAttribute('language', value, range);
+                    }
+                    else {
+                        writer.removeAttribute('language', range);
+                    }
+                }
+            }
+        });
+    }
+    /**
+     * Returns the attribute value of the first node in the selection that allows the attribute.
+     * For a collapsed selection it returns the selection attribute.
+     *
+     * @returns The attribute value.
+     */
+    _getValueFromFirstAllowedNode() {
+        const model = this.editor.model;
+        const schema = model.schema;
+        const selection = model.document.selection;
+        if (selection.isCollapsed) {
+            return selection.getAttribute('language') || false;
+        }
+        for (const range of selection.getRanges()) {
+            for (const item of range.getItems()) {
+                if (schema.checkAttribute(item, 'language')) {
+                    return item.getAttribute('language') || false;
+                }
+            }
+        }
+        return false;
+    }
+}

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