For the complete documentation index, see llms.txt. This page is also available as Markdown.

Check types

Grammar check

Grammar check is enabled by default. To disable it:

enableGrammar: false,

When grammar check is disabled, only spell check and style check run. Users won't be able to enable grammar from the Settings dialog or the grammar toggle in the UI.

Style check

Style suggestions are based on the rules created in the style guide. They're enabled by default. To disable them for users:

disableStyleGuide: true,

As-you-type proofreading

As-you-type proofreading is enabled by default. To disable it and allow proofreading only through the dialog mode:

proofreadAsYouType: false,

Spelling autocorrect

Autocorrect automatically fixes common spelling mistakes as users type. It's enabled by default. To disable it:

autocorrect: false,

Users can still toggle autocorrect from the Settings dialog. To prevent this, hide the General section using settingsSections. If you need to prevent the user's preference from persisting, add 'autocorrect' to disableOptionsStorage.

Text autocomplete

Autocomplete suggests the next word or short phrase based on context. Currently available for English only. Users accept suggestions with Tab or the Right arrow key. It's disabled by default. To enable it:

Users can toggle autocomplete from the Settings dialog.

AI writing assistant

The AI writing assistant (AIWA) is disabled by default. To enable it:

Users can initiate AIWA by selecting text (minimum 100 characters), clicking the badge, and choosing an action such as rewrite, shorten, expand, etc.

Suggestion visibility

You can control which suggestion types are visible to users without disabling the backend checks. All are true by default.

Setting any of these to false hides the suggestions in the UI, but requests are still sent to the backend. Users can turn them back on from the General section of the Settings dialog.

Check on space

By default, checking is triggered as the user types. To also trigger a check when the user presses space for faster underlining:

Language configuration profile

The checkKit option lets you choose between algorithmic, AI-powered, or mixed checking modes.

Not all configurations are available for all languages. The AI component is currently available for English, German, and Spanish. For languages without AI support, only the algorithmic check kit ('lt_hs') is available. If the specified configuration isn't supported for the selected language, the default configuration is used.

Value
Description

'lt_hs'

Algorithmic engines only, no AI.

'ai_lt_hs0'

AI provides grammar and spelling suggestions. Algorithmic engine highlights spelling errors without suggestions.

'ai_lt_hs1'

AI provides grammar and spelling suggestions, with algorithmic support where AI doesn't offer coverage.

'ai_lt'

AI provides grammar and spelling suggestions. Algorithmic grammar runs in parallel but AI takes precedence on overlaps.

'ai'

AI only, no algorithmic engines.

Last updated

Was this helpful?