mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 2

feat: add session.addWordToSpellCheckerDictionary to allow custom words in the dictionary (#21266)

Browse source 
* feat: add session.addWordToSpellCheckerDictionary to allow custom words in the dictionary

* Update session.md
This commit is contained in:
Samuel Attard 2019-11-26 13:16:43 -08:00 • committed by GitHub
parent 8a9c7c484b
commit 149aaeba94
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 38 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/api/session.md
View file

@ -464,12 +464,16 @@ The built in spellchecker does not automatically detect what language a user is
spell checker to correctly check their words you must call this API with an array of language codes. You can
get the list of supported language codes with the `ses.availableSpellCheckerLanguages` property.
**Note:** On macOS the OS spellchecker is used and will detect your language automatically. This API is a no-op on macOS.
#### `ses.getSpellCheckerLanguages()`
Returns `String[]` - An array of language codes the spellchecker is enabled for. If this list is empty the spellchecker
will fallback to using `en-US`. By default on launch if this setting is an empty list Electron will try to populate this
setting with the current OS locale. This setting is persisted across restarts.
**Note:** On macOS the OS spellchecker is used and has it's own list of languages. This API is a no-op on macOS.
#### `ses.setSpellCheckerDictionaryDownloadURL(url)`
* `url` String - A base URL for Electron to download hunspell dictionaries from.
@ -479,6 +483,16 @@ behavior you can use this API to point the dictionary downloader at your own hos
dictionaries. We publish a `hunspell_dictionaries.zip` file with each release which contains the files you need
to host here.
**Note:** On macOS the OS spellchecker is used and therefore we do not download any dictionary files. This API is a no-op on macOS.
#### `ses.addWordToSpellCheckerDictionary(word)`
* `word` String - The word you want to add to the dictionary
Returns `Boolean` - Whether the word was successfully written to the custom dictionary.
**Note:** On macOS and Windows 10 this word will be written to the OS custom dictionary as well
### Instance Properties
The following properties are available on instances of `Session`: