Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix readme to explain that spellcheck option is activated by default since Electron 9 #169

Merged
merged 3 commits into from
Aug 12, 2023
Merged

fix readme to explain that spellcheck option is activated by default since Electron 9 #169

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
56297e3
fix readme to explain that spellcheck option is activated by default …
samuel-fringeli Aug 12, 2023
1128a63
Update readme.md
sindresorhus Aug 12, 2023
7dd6bed
Update readme.md
sindresorhus Aug 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 4 additions & 12 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,7 @@ let mainWindow;
(async () => {
await app.whenReady();

mainWindow = new BrowserWindow({
webPreferences: {
spellcheck: true
}
});
mainWindow = new BrowserWindow();
})();
```

Expand Down Expand Up @@ -66,11 +62,7 @@ let mainWindow;
(async () => {
await app.whenReady();

mainWindow = new BrowserWindow({
webPreferences: {
spellcheck: true
}
});
mainWindow = new BrowserWindow();
})();
```

Expand Down Expand Up @@ -127,7 +119,7 @@ Default: `true`

Show the `Learn Spelling {selection}` menu item when right-clicking text.

Even if `true`, the `spellcheck` preference in browser window must still be enabled. It will also only show when right-clicking misspelled words.
The spellcheck will only show when right-clicking misspelled words.

#### showLookUpSelection

Expand Down Expand Up @@ -279,7 +271,7 @@ Even though you include an action, it will still only be shown/enabled when appr

`MenuItem` labels may contain the placeholder `{selection}` which will be replaced by the currently selected text as described in [`options.labels`](#labels).

To get spellchecking, “Correct Automatically”, and “Learn Spelling” in the menu, please enable the `spellcheck` preference in browser window: `new BrowserWindow({webPreferences: {spellcheck: true}})`
To get spellchecking, “Correct Automatically”, and “Learn Spelling” in the menu, make sure you have not disabled the `spellcheck` option (it's `true` by default) in `BrowserWindow`.

The following options are ignored when `menu` is used:

Expand Down