Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 2.7 KB

README.md

File metadata and controls

55 lines (38 loc) · 2.7 KB
Raw
category order url menu-title meta-title-short
howtos
160
guide/dev_howtos_scayt
Spell Checker and SCAYT
Spell Checker and SCAYT

Spell Checker and Spell Check As You Type (SCAYT)

The following article contains tips about customizing the spell checker behavior in CKEditor 4. Please refer to the {@link features/spellcheck/README Spell Checking} article for more information about the spell checker.

How Do I Set SCAYT to Turn On Automatically?

If you want to turn on the {@link features/spellcheck/README#spell-check-as-you-type-scayt Spell Check As You Type (SCAYT)} feature in CKEditor 4 by default, set the {@linkapi CKEDITOR.config#scayt_autoStartup CKEDITOR.config#scayt_autoStartup} configuration setting to true.

config.scayt_autoStartup = true;

How Do I Disable SCAYT in CKEditor 4?

If you want to completely disable the {@link features/spellcheck/README#spell-check-as-you-type-scayt Spell Check As You Type (SCAYT)} feature in CKEditor 4, remove the SpellCheckAsYouType (SCAYT) from your CKEditor 4 build with online builder or alternatively, disable the scayt plugin using the {@linkapi CKEDITOR.config#removePlugins CKEDITOR.config#removePlugins} configuration setting.

config.removePlugins = 'scayt';

If you want to leave SCAYT available, but prevent the feature from being turned on automatically on loading the editor, set the {@linkapi CKEDITOR.config#scayt_autoStartup CKEDITOR.config#scayt_autoStartup} configuration setting to false. This is the default value for CKEditor configuration.

config.scayt_autoStartup = false;

How Do I Change the Default Language for Spell Check As You Type (SCAYT)?

By default {@link features/spellcheck/README#spell-check-as-you-type-scayt SCAYT} treats the text written in the editor as American English (en_US). If you want to change the default SCAYT language, set the {@linkapi CKEDITOR.config#scayt_sLang CKEDITOR.config#scayt_sLang} configuration option to one of the 16 possible language codes that are currently accepted.

// Sets SCAYT to French.
config.scayt_sLang = 'fr_FR';

The option to store the user's chosen language may be disabled to make the language defined in config.scayt_sLang always used by default:

config.scayt_disableOptionsStorage = 'lang';

Language codes supported by SCAYT can be found in the {@linkapi CKEDITOR.config#scayt_sLang config.scayt_sLang option definition}. If you enter a language code that is not supported, SCAYT will fall back to the default American English setting.