@ckeditor/ckeditor5-language 40.0.0 → 40.2.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor&nbsp;5 text part language feature** – https://github.com/ckeditor/ckeditor5-language <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-language",
-  "version": "40.0.0",
+  "version": "40.2.0",
   "description": "Text part language feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "40.0.0"
+    "ckeditor5": "40.2.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",

package/src/augmentation.d.ts

@@ -1,47 +1,47 @@
-/**
- * @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 { TextPartLanguageOption, TextPartLanguage, TextPartLanguageEditing, TextPartLanguageUI, TextPartLanguageCommand } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface LanguageConfig {
-        /**
-         * The available {@link module:language/textpartlanguage~TextPartLanguage}
-         * options that allow setting the language of parts of the content.
-         *
-         * This configuration option is available only with the {@glink api/language text part language feature} enabled.
-         *
-         * Refer to the [WCAG 3.1.2 Language of Parts](https://www.w3.org/TR/UNDERSTANDING-WCAG20/meaning-other-lang-id.html) specification
-         * to learn more.
-         *
-         * To change the editor's UI language, refer to the {@glink features/ui-language Setting the UI language} guide.
-         *
-         * The default value is:
-         *
-         * ```ts
-         * const config = [
-         * 	{ title: 'Arabic', languageCode: 'ar' },
-         * 	{ title: 'French', languageCode: 'fr' },
-         * 	{ title: 'Spanish', languageCode: 'es' }
-         * ];
-         * ```
-         *
-         * The `title` property will be used by the text part language dropdown to render available options.
-         *
-         * The `languageCode` property is used for the `lang` attribute in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
-         *
-         * You can also specify the optional `textDirection` property indicating the reading direction of the language.
-         * Correct values are `ltr` and `rtl`. When the `textDirection` property is missing, the text part language feature will
-         * specify the text direction by itself.
-         */
-        textPartLanguage?: Array<TextPartLanguageOption>;
-    }
-    interface PluginsMap {
-        [TextPartLanguage.pluginName]: TextPartLanguage;
-        [TextPartLanguageEditing.pluginName]: TextPartLanguageEditing;
-        [TextPartLanguageUI.pluginName]: TextPartLanguageUI;
-    }
-    interface CommandsMap {
-        textPartLanguage: TextPartLanguageCommand;
-    }
-}
+/**
+ * @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 { TextPartLanguageOption, TextPartLanguage, TextPartLanguageEditing, TextPartLanguageUI, TextPartLanguageCommand } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface LanguageConfig {
+        /**
+         * The available {@link module:language/textpartlanguage~TextPartLanguage}
+         * options that allow setting the language of parts of the content.
+         *
+         * This configuration option is available only with the {@glink api/language text part language feature} enabled.
+         *
+         * Refer to the [WCAG 3.1.2 Language of Parts](https://www.w3.org/TR/UNDERSTANDING-WCAG20/meaning-other-lang-id.html) specification
+         * to learn more.
+         *
+         * To change the editor's UI language, refer to the {@glink features/ui-language Setting the UI language} guide.
+         *
+         * The default value is:
+         *
+         * ```ts
+         * const config = [
+         * 	{ title: 'Arabic', languageCode: 'ar' },
+         * 	{ title: 'French', languageCode: 'fr' },
+         * 	{ title: 'Spanish', languageCode: 'es' }
+         * ];
+         * ```
+         *
+         * The `title` property will be used by the text part language dropdown to render available options.
+         *
+         * The `languageCode` property is used for the `lang` attribute in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
+         *
+         * You can also specify the optional `textDirection` property indicating the reading direction of the language.
+         * Correct values are `ltr` and `rtl`. When the `textDirection` property is missing, the text part language feature will
+         * specify the text direction by itself.
+         */
+        textPartLanguage?: Array<TextPartLanguageOption>;
+    }
+    interface PluginsMap {
+        [TextPartLanguage.pluginName]: TextPartLanguage;
+        [TextPartLanguageEditing.pluginName]: TextPartLanguageEditing;
+        [TextPartLanguageUI.pluginName]: TextPartLanguageUI;
+    }
+    interface CommandsMap {
+        textPartLanguage: TextPartLanguageCommand;
+    }
+}

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 language
- */
-export { default as TextPartLanguage } from './textpartlanguage';
-export { default as TextPartLanguageEditing } from './textpartlanguageediting';
-export { default as TextPartLanguageUI } from './textpartlanguageui';
-export type { TextPartLanguageOption } from './textpartlanguageconfig';
-export type { default as TextPartLanguageCommand } from './textpartlanguagecommand';
-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 language
+ */
+export { default as TextPartLanguage } from './textpartlanguage';
+export { default as TextPartLanguageEditing } from './textpartlanguageediting';
+export { default as TextPartLanguageUI } from './textpartlanguageui';
+export type { TextPartLanguageOption } from './textpartlanguageconfig';
+export type { default as TextPartLanguageCommand } from './textpartlanguagecommand';
+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 language
- */
-export { default as TextPartLanguage } from './textpartlanguage';
-export { default as TextPartLanguageEditing } from './textpartlanguageediting';
-export { default as TextPartLanguageUI } from './textpartlanguageui';
-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 language
+ */
+export { default as TextPartLanguage } from './textpartlanguage';
+export { default as TextPartLanguageEditing } from './textpartlanguageediting';
+export { default as TextPartLanguageUI } from './textpartlanguageui';
+import './augmentation';

package/src/textpartlanguage.d.ts

@@ -1,35 +1,35 @@
-/**
- * @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/textpartlanguage
- */
-import { Plugin } from 'ckeditor5/src/core';
-import TextPartLanguageEditing from './textpartlanguageediting';
-import TextPartLanguageUI from './textpartlanguageui';
-/**
- * The text part language feature.
- *
- * This feature allows setting a language of the document's text part to support
- * [WCAG 3.1.2 Language of Parts](https://www.w3.org/TR/UNDERSTANDING-WCAG20/meaning-other-lang-id.html) specification.
- *
- * To change the editor's UI language, refer to the {@glink features/ui-language Setting the UI language} guide.
- *
- * For more information about this feature, check the {@glink api/language package page} as well as the {@glink features/language
- * Text part language} feature guide.
- *
- * This is a "glue" plugin which loads the
- * {@link module:language/textpartlanguageediting~TextPartLanguageEditing text part language editing feature}
- * and the {@link module:language/textpartlanguageui~TextPartLanguageUI text part language UI feature}.
- */
-export default class TextPartLanguage extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TextPartLanguageEditing, typeof TextPartLanguageUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TextPartLanguage";
-}
+/**
+ * @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/textpartlanguage
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import TextPartLanguageEditing from './textpartlanguageediting';
+import TextPartLanguageUI from './textpartlanguageui';
+/**
+ * The text part language feature.
+ *
+ * This feature allows setting a language of the document's text part to support
+ * [WCAG 3.1.2 Language of Parts](https://www.w3.org/TR/UNDERSTANDING-WCAG20/meaning-other-lang-id.html) specification.
+ *
+ * To change the editor's UI language, refer to the {@glink features/ui-language Setting the UI language} guide.
+ *
+ * For more information about this feature, check the {@glink api/language package page} as well as the {@glink features/language
+ * Text part language} feature guide.
+ *
+ * This is a "glue" plugin which loads the
+ * {@link module:language/textpartlanguageediting~TextPartLanguageEditing text part language editing feature}
+ * and the {@link module:language/textpartlanguageui~TextPartLanguageUI text part language UI feature}.
+ */
+export default class TextPartLanguage extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TextPartLanguageEditing, typeof TextPartLanguageUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TextPartLanguage";
+}

package/src/textpartlanguage.js

@@ -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
- */
-/**
- * @module language/textpartlanguage
- */
-import { Plugin } from 'ckeditor5/src/core';
-import TextPartLanguageEditing from './textpartlanguageediting';
-import TextPartLanguageUI from './textpartlanguageui';
-/**
- * The text part language feature.
- *
- * This feature allows setting a language of the document's text part to support
- * [WCAG 3.1.2 Language of Parts](https://www.w3.org/TR/UNDERSTANDING-WCAG20/meaning-other-lang-id.html) specification.
- *
- * To change the editor's UI language, refer to the {@glink features/ui-language Setting the UI language} guide.
- *
- * For more information about this feature, check the {@glink api/language package page} as well as the {@glink features/language
- * Text part language} feature guide.
- *
- * This is a "glue" plugin which loads the
- * {@link module:language/textpartlanguageediting~TextPartLanguageEditing text part language editing feature}
- * and the {@link module:language/textpartlanguageui~TextPartLanguageUI text part language UI feature}.
- */
-export default class TextPartLanguage extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [TextPartLanguageEditing, TextPartLanguageUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'TextPartLanguage';
-    }
-}
+/**
+ * @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/textpartlanguage
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import TextPartLanguageEditing from './textpartlanguageediting';
+import TextPartLanguageUI from './textpartlanguageui';
+/**
+ * The text part language feature.
+ *
+ * This feature allows setting a language of the document's text part to support
+ * [WCAG 3.1.2 Language of Parts](https://www.w3.org/TR/UNDERSTANDING-WCAG20/meaning-other-lang-id.html) specification.
+ *
+ * To change the editor's UI language, refer to the {@glink features/ui-language Setting the UI language} guide.
+ *
+ * For more information about this feature, check the {@glink api/language package page} as well as the {@glink features/language
+ * Text part language} feature guide.
+ *
+ * This is a "glue" plugin which loads the
+ * {@link module:language/textpartlanguageediting~TextPartLanguageEditing text part language editing feature}
+ * and the {@link module:language/textpartlanguageui~TextPartLanguageUI text part language UI feature}.
+ */
+export default class TextPartLanguage extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [TextPartLanguageEditing, TextPartLanguageUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TextPartLanguage';
+    }
+}

package/src/textpartlanguagecommand.d.ts

@@ -1,70 +1,70 @@
-/**
- * @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/textpartlanguagecommand
- */
-import type { LanguageDirection } from 'ckeditor5/src/utils';
-import { Command } from 'ckeditor5/src/core';
-/**
- * The text part language command plugin.
- */
-export default class TextPartLanguageCommand extends Command {
-    /**
-     * If the selection starts in a language attribute, the value is set to
-     * the value of that language in the following 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.
-     *
-     * It is set to `false` otherwise.
-     *
-     * @observable
-     * @readonly
-     */
-    value: false | string;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * 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 }?: {
-        languageCode?: string | false;
-        textDirection?: LanguageDirection;
-    }): void;
-    /**
-     * 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.
-     */
-    private _getValueFromFirstAllowedNode;
-}
+/**
+ * @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/textpartlanguagecommand
+ */
+import type { LanguageDirection } from 'ckeditor5/src/utils';
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The text part language command plugin.
+ */
+export default class TextPartLanguageCommand extends Command {
+    /**
+     * If the selection starts in a language attribute, the value is set to
+     * the value of that language in the following 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.
+     *
+     * It is set to `false` otherwise.
+     *
+     * @observable
+     * @readonly
+     */
+    value: false | string;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * 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 }?: {
+        languageCode?: string | false;
+        textDirection?: LanguageDirection;
+    }): void;
+    /**
+     * 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.
+     */
+    private _getValueFromFirstAllowedNode;
+}