@richhtmleditor/spellcheck

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.

Current release: 1.2.7 — Depends on @richhtmleditor/core ^1.2.7.

Repository: github.com/rajkishorsahu89/richhtmleditor

Demo: richhtmleditor.stackkitlabs.com — demo · guide · API

What's in 1.2.7

• createSpellcheckPlugin — registers the spellcheck toolbar tool
• Red underlines — misspelled words highlighted in real time as you type
• Suggestions popup — click a misspelled word to see corrections
• Custom dictionary — add project-specific words that should not be flagged
• Toggle on/off — toolbar button enables or disables spell checking

Community feature — no enterprise licence required.

Keywords: richhtmleditor spellcheck spelling grammar wysiwyg

Install

npm install @richhtmleditor/spellcheck
# Requires @richhtmleditor/core (via framework wrapper or direct install).

Usage

import { createEditor } from "@richhtmleditor/core";
import { createSpellcheckPlugin } from "@richhtmleditor/spellcheck";

const editor = createEditor({
  element: host,
  toolbar: { preset: "full" },
  plugins: [createSpellcheckPlugin()]
});

Angular

import { createSpellcheckPlugin } from "@richhtmleditor/spellcheck";

plugins = [createSpellcheckPlugin({ language: "en-US" })];

<richhtmleditor [plugins]="plugins" [toolbar]="{ preset: 'full' }" />

Custom dictionary

createSpellcheckPlugin({
  language: "en-US",
  customWords: ["richhtmleditor", "WYSIWYG", "Mermaid"]
})

API

createSpellcheckPlugin(options?)

Returns an EditorPlugin that registers the spellcheck toolbar tool.

| Option | Type | Description | | --- | --- | --- | | language | string? | Language code for spell checking (default: "en-US"). | | customWords | string[]? | Additional words to accept as correct. | | enabled | boolean? | Start with spell check enabled (default: true). |

Related packages

• @richhtmleditor/core — editor engine and plugins API.
• @richhtmleditor/themes — shared CSS.
• @richhtmleditor/mentions — @ mentions plugin.
• @richhtmleditor/angular — Angular wrapper.
• @richhtmleditor/react — React wrapper.

License

MIT