Add showLearnSpelling option (#157)

sindresorhus · Jun 10, 2022 · 3bb622a · 3bb622a
1 parent ac00d0f
commit 3bb622a
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 5 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -139,14 +139,23 @@ declare namespace contextMenu {
 		) => MenuItemConstructorOptions[];
 
 		/**
-		Show the `Look Up {selection}` menu item when right-clicking text on macOS.
+		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.
+
+		@default true
+		*/
+		readonly showLearnSpelling?: boolean;
+
+		/**
+		Show the `Look Up {selection}` menu item when right-clicking text.
 
 		@default true
 		*/
 		readonly showLookUpSelection?: boolean;
 
 		/**
-		Show the `Search with Google` menu item when right-clicking text on macOS.
+		Show the `Search with Google` menu item when right-clicking text.
 
 		@default true
 		*/
@@ -254,6 +263,7 @@ declare namespace contextMenu {
 
 		The following options are ignored when `menu` is used:
 
+		- `showLearnSpelling`
 		- `showLookUpSelection`
 		- `showSearchWithGoogle`
 		- `showCopyImage`

diff --git a/index.js b/index.js
@@ -231,7 +231,7 @@ const create = (win, options) => {
 			dictionarySuggestions.length > 0 && defaultActions.separator(),
 			...dictionarySuggestions,
 			defaultActions.separator(),
-			defaultActions.learnSpelling(),
+			options.showLearnSpelling !== false && defaultActions.learnSpelling(),
 			defaultActions.separator(),
 			options.showLookUpSelection !== false && defaultActions.lookUpSelection(),
 			defaultActions.separator(),

diff --git a/readme.md b/readme.md
@@ -120,19 +120,28 @@ The first argument is an array of default actions that can be used. The second a
 
 `MenuItem` labels may contain the placeholder `{selection}` which will be replaced by the currently selected text as described in [`options.labels`](#labels).
 
+#### showLearnSpelling
+
+Type: `boolean`\
+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.
+
 #### showLookUpSelection
 
 Type: `boolean`\
 Default: `true`
 
-Show the `Look Up {selection}` menu item when right-clicking text on macOS.
+Show the `Look Up {selection}` menu item when right-clicking text.
 
 #### showSearchWithGoogle
 
 Type: `boolean`\
 Default: `true`
 
-Show the `Search with Google` menu item when right-clicking text on macOS.
+Show the `Search with Google` menu item when right-clicking text.
 
 #### showCopyImage