@richhtmleditor/spellcheck 1.1.2 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +86 -86
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,86 +1,86 @@
1
- # @richhtmleditor/spellcheck
2
-
3
- Real-time spell checking plugin for Rich HTML Editor. Adds a **Spellcheck** toolbar toggle that underlines misspelled words with suggestions popup on click. Built on [`@richhtmleditor/core`](https://www.npmjs.com/package/@richhtmleditor/core).
4
-
5
- **Current release: 1.1.2** — Depends on `@richhtmleditor/core` **^1.1.2**.
6
-
7
- **Repository:** [github.com/rajkishorsahu89/richhtmleditor](https://github.com/rajkishorsahu89/richhtmleditor)
8
-
9
- **Demo:** [richhtmleditor.vercel.app](https://richhtmleditor.vercel.app/) — [demo](https://richhtmleditor.vercel.app/demo) · [guide](https://richhtmleditor.vercel.app/guide) · [API](https://richhtmleditor.vercel.app/api)
10
-
11
- ### What's in 1.1.2
12
-
13
- - **`createSpellcheckPlugin`** — registers the `spellcheck` toolbar tool
14
- - **Red underlines** — misspelled words highlighted in real time as you type
15
- - **Suggestions popup** — click a misspelled word to see corrections
16
- - **Custom dictionary** — add project-specific words that should not be flagged
17
- - **Toggle on/off** — toolbar button enables or disables spell checking
18
-
19
- > Community feature — no enterprise licence required.
20
-
21
- **Keywords:** `richhtmleditor` `spellcheck` `spelling` `grammar` `wysiwyg`
22
-
23
- ## Install
24
-
25
- ```bash
26
- npm install @richhtmleditor/spellcheck
27
- # Requires @richhtmleditor/core (via framework wrapper or direct install).
28
- ```
29
-
30
- ## Usage
31
-
32
- ```ts
33
- import { createEditor } from "@richhtmleditor/core";
34
- import { createSpellcheckPlugin } from "@richhtmleditor/spellcheck";
35
-
36
- const editor = createEditor({
37
- element: host,
38
- toolbar: { preset: "full" },
39
- plugins: [createSpellcheckPlugin()]
40
- });
41
- ```
42
-
43
- ### Angular
44
-
45
- ```ts
46
- import { createSpellcheckPlugin } from "@richhtmleditor/spellcheck";
47
-
48
- plugins = [createSpellcheckPlugin({ language: "en-US" })];
49
- ```
50
-
51
- ```html
52
- <richhtmleditor [plugins]="plugins" [toolbar]="{ preset: 'full' }" />
53
- ```
54
-
55
- ### Custom dictionary
56
-
57
- ```ts
58
- createSpellcheckPlugin({
59
- language: "en-US",
60
- customWords: ["richhtmleditor", "WYSIWYG", "Mermaid"]
61
- })
62
- ```
63
-
64
- ## API
65
-
66
- ### `createSpellcheckPlugin(options?)`
67
-
68
- Returns an `EditorPlugin` that registers the `spellcheck` toolbar tool.
69
-
70
- | Option | Type | Description |
71
- | --- | --- | --- |
72
- | `language` | `string?` | Language code for spell checking (default: `"en-US"`). |
73
- | `customWords` | `string[]?` | Additional words to accept as correct. |
74
- | `enabled` | `boolean?` | Start with spell check enabled (default: `true`). |
75
-
76
- ## Related packages
77
-
78
- - [`@richhtmleditor/core`](https://www.npmjs.com/package/@richhtmleditor/core) — editor engine and plugins API.
79
- - [`@richhtmleditor/themes`](https://www.npmjs.com/package/@richhtmleditor/themes) — shared CSS.
80
- - [`@richhtmleditor/mentions`](https://www.npmjs.com/package/@richhtmleditor/mentions) — @ mentions plugin.
81
- - [`@richhtmleditor/angular`](https://www.npmjs.com/package/@richhtmleditor/angular) — Angular wrapper.
82
- - [`@richhtmleditor/react`](https://www.npmjs.com/package/@richhtmleditor/react) — React wrapper.
83
-
84
- ## License
85
-
86
- [MIT](./LICENSE)
1
+ # @richhtmleditor/spellcheck
2
+
3
+ Real-time spell checking plugin for Rich HTML Editor. Adds a **Spellcheck** toolbar toggle that underlines misspelled words with suggestions popup on click. Built on [`@richhtmleditor/core`](https://www.npmjs.com/package/@richhtmleditor/core).
4
+
5
+ **Current release: 1.1.3** — Depends on `@richhtmleditor/core` **^1.1.3**.
6
+
7
+ **Repository:** [github.com/rajkishorsahu89/richhtmleditor](https://github.com/rajkishorsahu89/richhtmleditor)
8
+
9
+ **Demo:** [richhtmleditor.vercel.app](https://richhtmleditor.vercel.app/) — [demo](https://richhtmleditor.vercel.app/demo) · [guide](https://richhtmleditor.vercel.app/guide) · [API](https://richhtmleditor.vercel.app/api)
10
+
11
+ ### What's in 1.1.3
12
+
13
+ - **`createSpellcheckPlugin`** — registers the `spellcheck` toolbar tool
14
+ - **Red underlines** — misspelled words highlighted in real time as you type
15
+ - **Suggestions popup** — click a misspelled word to see corrections
16
+ - **Custom dictionary** — add project-specific words that should not be flagged
17
+ - **Toggle on/off** — toolbar button enables or disables spell checking
18
+
19
+ > Community feature — no enterprise licence required.
20
+
21
+ **Keywords:** `richhtmleditor` `spellcheck` `spelling` `grammar` `wysiwyg`
22
+
23
+ ## Install
24
+
25
+ ```bash
26
+ npm install @richhtmleditor/spellcheck
27
+ # Requires @richhtmleditor/core (via framework wrapper or direct install).
28
+ ```
29
+
30
+ ## Usage
31
+
32
+ ```ts
33
+ import { createEditor } from "@richhtmleditor/core";
34
+ import { createSpellcheckPlugin } from "@richhtmleditor/spellcheck";
35
+
36
+ const editor = createEditor({
37
+ element: host,
38
+ toolbar: { preset: "full" },
39
+ plugins: [createSpellcheckPlugin()]
40
+ });
41
+ ```
42
+
43
+ ### Angular
44
+
45
+ ```ts
46
+ import { createSpellcheckPlugin } from "@richhtmleditor/spellcheck";
47
+
48
+ plugins = [createSpellcheckPlugin({ language: "en-US" })];
49
+ ```
50
+
51
+ ```html
52
+ <richhtmleditor [plugins]="plugins" [toolbar]="{ preset: 'full' }" />
53
+ ```
54
+
55
+ ### Custom dictionary
56
+
57
+ ```ts
58
+ createSpellcheckPlugin({
59
+ language: "en-US",
60
+ customWords: ["richhtmleditor", "WYSIWYG", "Mermaid"]
61
+ })
62
+ ```
63
+
64
+ ## API
65
+
66
+ ### `createSpellcheckPlugin(options?)`
67
+
68
+ Returns an `EditorPlugin` that registers the `spellcheck` toolbar tool.
69
+
70
+ | Option | Type | Description |
71
+ | --- | --- | --- |
72
+ | `language` | `string?` | Language code for spell checking (default: `"en-US"`). |
73
+ | `customWords` | `string[]?` | Additional words to accept as correct. |
74
+ | `enabled` | `boolean?` | Start with spell check enabled (default: `true`). |
75
+
76
+ ## Related packages
77
+
78
+ - [`@richhtmleditor/core`](https://www.npmjs.com/package/@richhtmleditor/core) — editor engine and plugins API.
79
+ - [`@richhtmleditor/themes`](https://www.npmjs.com/package/@richhtmleditor/themes) — shared CSS.
80
+ - [`@richhtmleditor/mentions`](https://www.npmjs.com/package/@richhtmleditor/mentions) — @ mentions plugin.
81
+ - [`@richhtmleditor/angular`](https://www.npmjs.com/package/@richhtmleditor/angular) — Angular wrapper.
82
+ - [`@richhtmleditor/react`](https://www.npmjs.com/package/@richhtmleditor/react) — React wrapper.
83
+
84
+ ## License
85
+
86
+ [MIT](./LICENSE)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@richhtmleditor/spellcheck",
3
- "version": "1.1.2",
3
+ "version": "1.1.3",
4
4
  "description": "Spell & grammar check plugin for Rich HTML Editor (browser-native + LanguageTool API).",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",