Interface ElectronSpellcheckApi

Renderer-side access to Chromium's built-in spell checker.

interface ElectronSpellcheckApi {
    addWordToDictionary(word: string): void;
    getAvailableSpellCheckerLanguages(): string[];
    setSpellCheckerEnabled(enabled: boolean): void;
    setSpellCheckerLanguages(languageCodes: string[]): void;
}

Index

Methods

addWordToDictionary getAvailableSpellCheckerLanguages setSpellCheckerEnabled setSpellCheckerLanguages

Methods

addWordToDictionary

addWordToDictionary(word: string): void
Adds a word to the user's personal dictionary so it is no longer flagged.
Parameters
- word: string
Returns void
- Defined in packages/commons/dist/lib/electron_api_interface.d.ts:272

getAvailableSpellCheckerLanguages

getAvailableSpellCheckerLanguages(): string[]
Returns the BCP-47 language tags Chromium can spell-check on this platform.

Returns string[]
- Defined in packages/commons/dist/lib/electron_api_interface.d.ts:274

setSpellCheckerEnabled

setSpellCheckerEnabled(enabled: boolean): void
Enables or disables the built-in spell checker on every open window's session immediately, without an application restart.
Parameters
- enabled: boolean
Returns void
- Defined in packages/commons/dist/lib/electron_api_interface.d.ts:285

setSpellCheckerLanguages

setSpellCheckerLanguages(languageCodes: string[]): void
Applies the spell-check language list to every open window's session immediately, without an application restart. No-op on macOS, where the OS spell checker auto-detects the language.
Parameters
- languageCodes: string[]
Returns void
- Defined in packages/commons/dist/lib/electron_api_interface.d.ts:280