CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

language/utils

@ckeditor/ckeditor5-language/src/utils

module

Filtering

Functions

  • parseLanguageAttribute( str ) → Object

    Retrieves language properties converted to attribute value by the stringifyLanguageAttribute function.

    See source

    Parameters

    str : String

    The attribute value.

    Returns

    Object

    result

    String

    result.languageCode The language code in the ISO 639 format.

    String

    result.textDirection The language text direction.

  • stringifyLanguageAttribute( languageCode, [ textDirection ] ) → String

    Returns the language attribute value in a human-readable text format:

    See source
    <languageCode>:<textDirection>
    • languageCode - The language code used for the lang attribute in the ISO 639-1 format.
    • textDirection - One of the following values: rtl or ltr, indicating the reading direction of the language.

    See the text part language configuration for more information about language properties.

    If the textDirection argument is omitted, it will be automatically detected based on languageCode.

    Parameters

    languageCode : String

    The language code in the ISO 639-1 format.

    [ textDirection ] : 'ltr' | 'rtl'

    The language text direction. Automatically detected if omitted.

    Returns

    String