Text part language

The text part language feature provides the ability to mark the language of selected text fragments. It makes working with multilingual content convenient and ensures that user agents can correctly present the content written in multiple languages, so graphical browsers and screen readers are able to identify how to pronounce text and display characters.

This feature is especially useful when your content includes text sections written in different text directions, e.g. when the whole content is written in English but includes some citations in Arabic.

The text part language feature implements the WCAG 3.1.2 Language of Parts specification.

# Demo

Use the language toolbar dropdown in the editor below to see the feature in action. Select a text fragment and use the toolbar dropdown to choose from predefined available languages that can be applied to the content.

# Related features

There are other language-related CKEditor 5 features you may want to check:

• UI Language – Set the UI language.
• Spelling and grammar checking – Employ multi-language spell check for flawless content.

# Configuring available languages

To modify the list of available languages displayed in the language dropdown use the config.language.textPartLanguage configuration option.

The example below shows the configuration used for the demo above:

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        // More of editor's config.
        // ...
        language: {
            textPartLanguage: [
                { title: 'Arabic', languageCode: 'ar' },
                { title: 'French', languageCode: 'fr' },
                { title: 'Hebrew', languageCode: 'he' },
                { title: 'Spanish', languageCode: 'es' }
            ]
        }
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

# Installation

To add this feature to your rich-text editor, install the @ckeditor/ckeditor5-language package:

npm install --save @ckeditor/ckeditor5-language

And add it to your plugin list configuration:

import TextPartLanguage from '@ckeditor/ckeditor5-language/src/textpartlanguage';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ TextPartLanguage, /* ... */ ],
        toolbar: [ 'textPartLanguage', /* ... */ ]
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

# Common API

The TextPartLanguage plugin registers:

• The 'textPartLanguage' UI dropdown component implemented by the text part language UI feature.
• The 'textPartLanguage' command implemented by the text part language editing feature.

The command can be executed using the editor.execute() method:

// Applies the language to the selected text part with the given language code.
editor.execute( 'textPartLanguage', { languageCode: 'es' } );

# Contribute

The source code of the feature is available on GitHub in https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-language.