mirror of
https://github.com/electron/electron.git
synced 2026-10-28 11:44:46 +08:00
Samuel AttardandClaude
ad3a896a52
* build: check the formatting of docs code blocks with oxfmt lint-roller 4 splits the old `lint-roller-markdown-standard` into an oxlint half and an oxfmt half. This wires up the second one: `lint:fmt-in-markdown` runs `lint-roller-markdown-oxfmt` over docs/ as part of `lint:docs`, using docs/.oxfmtrc.json, which matches the repo's .oxfmtrc.json except that docs snippets keep their semicolon-free style. `--fix` writes the formatted blocks back, and a block can opt out with `@noformat` in its info string. * docs: format code blocks with oxfmt Result of `lint-roller-markdown-oxfmt --fix` with docs/.oxfmtrc.json, plus the @ts-expect-error line anchors (and one Docusaurus highlight marker) that moved with the reformat. The Babel output sample in the ESM guide and the two excerpts of repo source in creating-api.md are marked @noformat, and the contentTracing example passes an async callback instead of wrapping an IIFE so that it does not need a leading semicolon. --------- Co-authored-by: Claude <noreply@anthropic.com>
77 lines
3.0 KiB
Markdown
77 lines
3.0 KiB
Markdown
# SpellChecker
|
|
|
|
Electron has built-in support for Chromium's spellchecker since Electron 8. On Windows and Linux this is powered by Hunspell dictionaries, and on macOS it makes use of the native spellchecker APIs.
|
|
|
|
## How to enable the spellchecker?
|
|
|
|
For Electron 9 and higher the spellchecker is enabled by default. For Electron 8 you need to enable it in `webPreferences`.
|
|
|
|
```js
|
|
const myWindow = new BrowserWindow({
|
|
webPreferences: {
|
|
spellcheck: true
|
|
}
|
|
})
|
|
```
|
|
|
|
## How to set the languages the spellchecker uses?
|
|
|
|
On macOS as we use the native APIs there is no way to set the language that the spellchecker uses. By default on macOS the native spellchecker will automatically detect the language being used for you.
|
|
|
|
For Windows and Linux there are a few Electron APIs you should use to set the languages for the spellchecker.
|
|
|
|
```js @ts-type={myWindow:Electron.BrowserWindow}
|
|
// Sets the spellchecker to check English US and French
|
|
myWindow.webContents.session.setSpellCheckerLanguages(['en-US', 'fr'])
|
|
|
|
// An array of all available language codes
|
|
const possibleLanguages = myWindow.webContents.session.availableSpellCheckerLanguages
|
|
```
|
|
|
|
By default the spellchecker will enable the language matching the current OS locale.
|
|
|
|
## How do I put the results of the spellchecker in my context menu?
|
|
|
|
All the required information to generate a context menu is provided in the [`context-menu`](../api/web-contents.md#event-context-menu) event on each `webContents` instance. A small example
|
|
of how to make a context menu with this information is provided below.
|
|
|
|
```js @ts-type={myWindow:Electron.BrowserWindow}
|
|
const { Menu, MenuItem } = require('electron')
|
|
|
|
myWindow.webContents.on('context-menu', (event, params) => {
|
|
const menu = new Menu()
|
|
|
|
// Add each spelling suggestion
|
|
for (const suggestion of params.dictionarySuggestions) {
|
|
menu.append(
|
|
new MenuItem({
|
|
label: suggestion,
|
|
click: () => myWindow.webContents.replaceMisspelling(suggestion)
|
|
})
|
|
)
|
|
}
|
|
|
|
// Allow users to add the misspelled word to the dictionary
|
|
if (params.misspelledWord) {
|
|
menu.append(
|
|
new MenuItem({
|
|
label: 'Add to dictionary',
|
|
click: () => myWindow.webContents.session.addWordToSpellCheckerDictionary(params.misspelledWord)
|
|
})
|
|
)
|
|
}
|
|
|
|
menu.popup()
|
|
})
|
|
```
|
|
|
|
## Does the spellchecker use any Google services?
|
|
|
|
Although the spellchecker itself does not send any typings, words or user input to Google services the hunspell dictionary files are downloaded from a Google CDN by default. If you want to avoid this you can provide an alternative URL to download the dictionaries from.
|
|
|
|
```js @ts-type={myWindow:Electron.BrowserWindow}
|
|
myWindow.webContents.session.setSpellCheckerDictionaryDownloadURL('https://example.com/dictionaries/')
|
|
```
|
|
|
|
Check out the docs for [`session.setSpellCheckerDictionaryDownloadURL`](../api/session.md#sessetspellcheckerdictionarydownloadurlurl) for more information on where to get the dictionary files from and how you need to host them.
|