@ckeditor/ckeditor5-language 41.3.0-alpha.3 → 41.3.0

package/dist/types/textpartlanguagecommand.d.ts

@@ -1,74 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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.js';
-import { Command } from 'ckeditor5/src/core.js';
-/**
- * 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;
-}

package/dist/types/textpartlanguageconfig.d.ts

@@ -1,29 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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.js';
-/**
- * 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/dist/types/textpartlanguageediting.d.ts

@@ -1,32 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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.js';
-/**
- * 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/dist/types/textpartlanguageui.d.ts

@@ -1,27 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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.js';
-/**
- * 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/dist/types/utils.d.ts

@@ -1,44 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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.js';
-/**
- * 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;
-};