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.

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

Add built-in support for spellchecking #94

Merged
merged 16 commits into from
Apr 14, 2020
6 changes: 5 additions & 1 deletion fixture-menu.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,9 @@ contextMenu({
(async () => {
await app.whenReady();

await (new BrowserWindow()).loadFile(path.join(__dirname, 'fixture.html'));
await (new BrowserWindow({
webPreferences: {
spellcheck: true
nautatva marked this conversation as resolved.
Show resolved Hide resolved
}
})).loadFile(path.join(__dirname, 'fixture.html'));
})();
2 changes: 1 addition & 1 deletion fixture.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ contextMenu({

await (new BrowserWindow({
webPreferences: {
nodeIntegration: true
spellcheck: true
}
})).loadFile(path.join(__dirname, 'fixture.html'));
})();
34 changes: 32 additions & 2 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@ declare namespace contextMenu {
@default 'Look Up “{selection}”'
*/
readonly lookUpSelection?: string;

/**
@default 'Search with Google'
*/
readonly searchWithGoogle?: string;

/**
@default 'Correct Automatically'
*/
readonly correctAutomatically?: string;

/**
@default 'Learn Spelling'
*/
readonly learnSpelling?: string;
nautatva marked this conversation as resolved.
Show resolved Hide resolved

/**
@default 'Cut'
Expand Down Expand Up @@ -81,6 +96,9 @@ declare namespace contextMenu {
interface Actions {
readonly separator: () => MenuItemConstructorOptions;
readonly lookUpSelection: (options: ActionOptions) => MenuItemConstructorOptions;
readonly searchWithGoogle: (options: ActionOptions) => MenuItemConstructorOptions;
readonly correctAutomatically: (options: ActionOptions) => MenuItemConstructorOptions;
readonly learnSpelling: (options: ActionOptions) => MenuItemConstructorOptions;
nautatva marked this conversation as resolved.
Show resolved Hide resolved
readonly cut: (options: ActionOptions) => MenuItemConstructorOptions;
readonly copy: (options: ActionOptions) => MenuItemConstructorOptions;
readonly paste: (options: ActionOptions) => MenuItemConstructorOptions;
Expand Down Expand Up @@ -129,6 +147,13 @@ declare namespace contextMenu {
*/
readonly showLookUpSelection?: boolean;

/**
Show the `Search with Google` menu item when right-clicking text on macOS.

@default true
*/
readonly showSearchWithGoogle?: boolean;

/**
Show the `Copy Image` menu item when right-clicking on an image.

Expand Down Expand Up @@ -217,8 +242,13 @@ declare namespace contextMenu {
- `showSaveImageAs`
- `showInspectElement`
- `showServices`
- `showSearchWithGoogle`
nautatva marked this conversation as resolved.
Show resolved Hide resolved

nautatva marked this conversation as resolved.
Show resolved Hide resolved

To get spellcheck, Correct Automatically and Learn Spelling in the menu, please enable the `spellcheck` preference in browser window.
`new BrowserWindow({ webPreferences: {spellcheck: true}})`

@default [defaultActions.cut(), defaultActions.copy(), defaultActions.paste(), defaultActions.separator(), defaultActions.saveImage(), defaultActions.saveImageAs(), defaultActions.copyLink(), defaultActions.copyImage(), defaultActions.copyImageAddress(), defaultActions.separator(), defaultActions.copyLink(), defaultActions.separator(), defaultActions.inspect()]
@default [...dictionarySuggestions, defaultActions.separator(), defaultActions.correctAutomatically(), defaultActions.separator(), defaultActions.learnSpelling(), defaultActions.separator(), defaultActions.lookUpSelection(), defaultActions.separator(),defaultActions.searchWithGoogle(), defaultActions.cut(), defaultActions.copy(), defaultActions.paste(), defaultActions.separator(), defaultActions.saveImage(), defaultActions.saveImageAs(), defaultActions.copyLink(), defaultActions.copyImage(), defaultActions.copyImageAddress(), defaultActions.separator(), defaultActions.copyLink(), defaultActions.separator(), defaultActions.inspect()]
*/
readonly menu?: (
defaultActions: Actions,
Expand Down Expand Up @@ -249,7 +279,7 @@ contextMenu({
let mainWindow;
(async () => {
await app.whenReady();
mainWindow = new BrowserWindow();
mainWindow = new BrowserWindow({ webPreferences: {spellcheck: true}});
});
```
*/
Expand Down
62 changes: 62 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,16 @@ const create = (win, options) => {
}
}
}),
searchWithGoogle: decorateMenuItem({
id: 'searchWithGoogle',
label: 'Search with Google',
visible: hasText,
click() {
const url = new URL('https://www.google.com/search');
url.searchParams.set('q', props.selectionText);
electron.shell.openExternal(url.toString());
}
}),
nautatva marked this conversation as resolved.
Show resolved Hide resolved
cut: decorateMenuItem({
id: 'cut',
label: 'Cut',
Expand Down Expand Up @@ -152,6 +162,24 @@ const create = (win, options) => {
});
}
}),
correctAutomatically: decorateMenuItem({
sindresorhus marked this conversation as resolved.
Show resolved Hide resolved
id: 'correctAutomatically',
label: 'Correct Spelling Automatically',
visible: props.isEditable && hasText && props.misspelledWord && props.dictionarySuggestions.length,
nautatva marked this conversation as resolved.
Show resolved Hide resolved
click() {
const target = webContents(win);
target.insertText(props.dictionarySuggestions[0]);
}
}),
learnSpelling: decorateMenuItem({
id: 'learnSpelling',
label: 'Learn Spelling',
visible: props.isEditable && hasText && props.misspelledWord,
click() {
const target = webContents(win);
target.session.addWordToSpellCheckerDictionary(props.misspelledWord);
}
}),
nautatva marked this conversation as resolved.
Show resolved Hide resolved
inspect: () => ({
id: 'inspect',
label: 'Inspect Element',
Expand All @@ -173,10 +201,44 @@ const create = (win, options) => {

const shouldShowInspectElement = typeof options.showInspectElement === 'boolean' ? options.showInspectElement : isDev;

function word(suggestion) {
return {
id: 'dictionarySuggestions',
label: suggestion,
visible: props.isEditable && hasText && props.misspelledWord,
click(menuItem) {
const target = webContents(win);
target.insertText(menuItem.label);
}
};
}

let dictionarySuggestions = [];
if (hasText && props.misspelledWord && props.dictionarySuggestions.length > 0) {
dictionarySuggestions = props.dictionarySuggestions.map(word);
} else {
dictionarySuggestions.push(
{
id: 'dictionarySuggestions',
label: 'No guesses available',
nautatva marked this conversation as resolved.
Show resolved Hide resolved
visible: hasText && props.misspelledWord,
enabled: false
}
);
}

let menuTemplate = [
defaultActions.separator(),
...dictionarySuggestions,
defaultActions.separator(),
defaultActions.correctAutomatically(),
defaultActions.separator(),
defaultActions.learnSpelling(),
defaultActions.separator(),
options.showLookUpSelection !== false && defaultActions.lookUpSelection(),
defaultActions.separator(),
options.showSearchWithGoogle !== false && defaultActions.searchWithGoogle(),
defaultActions.separator(),
defaultActions.cut(),
defaultActions.copy(),
defaultActions.paste(),
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"devDependencies": {
"@types/node": "^12.0.10",
"ava": "^2.1.0",
"electron": "^7.1.1",
"electron": "^8.0.0",
"tsd": "^0.10.0",
"xo": "^0.25.3"
},
Expand Down
28 changes: 25 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,12 @@ contextMenu({
let mainWindow;
(async () => {
await app.whenReady();
mainWindow = new BrowserWindow();

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

Expand Down Expand Up @@ -90,6 +95,13 @@ Default: `true`

Show the `Look Up {selection}` menu item when right-clicking text on macOS.

#### showSearchWithGoogle

Type: `boolean`\
Default: `true`

Show the `Search with Google` menu item when right-clicking text on macOS.

#### showCopyImage

Type: `boolean`\
Expand Down Expand Up @@ -185,11 +197,20 @@ The following options are ignored when `menu` is used:
- `showSaveImageAs`
- `showInspectElement`
- `showServices`

- `showSearchWithGoogle`

nautatva marked this conversation as resolved.
Show resolved Hide resolved
Default actions:

To get spellcheck, Correct Automatically and Learn Spelling in the menu, please enable the `spellcheck` preference in browser window.
Format:
`new BrowserWindow({ webPreferences: {spellcheck: true}})`

- `spellCheck`
- `correctAutomatically`
- `learnSpelling`
- `separator`
- `lookUpSelection`
- `searchWithGoogle`
- `cut`
- `copy`
- `paste`
Expand All @@ -201,7 +222,8 @@ Default actions:
- `inspect`
- `services`

Example:

Example for actions:

```js
{
Expand Down