# codemirror-spell-checker

> Dead-simple spell checking in CodeMirror.

Latest version **1.1.2** (published 2016-06-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install codemirror-spell-checker
pnpm add codemirror-spell-checker
yarn add codemirror-spell-checker
bun add codemirror-spell-checker
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2016-06-14 |
| First published | 2016-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 88 |
| Author | Wes Cossick |
| Maintainers | nextstepwebs |
| Keywords | codemirror, code, mirror, spell, checker, checking, spellchecker, spellchecking, javascript |

## Links

- npm: https://www.npmjs.com/package/codemirror-spell-checker
- Repository: https://github.com/NextStepWebs/codemirror-spell-checker
- Issues: https://github.com/NextStepWebs/codemirror-spell-checker/issues
- npm.io page: https://npm.io/package/codemirror-spell-checker

## Dependencies (1)

- [typo-js](https://npm.io/package/typo-js.md) *

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 1.1.2 (latest) — 2016-06-14
- 1.1.1 — 2016-06-07
- 1.1.0 — 2016-06-07

## README

# CodeMirror Spell Checker
Spell checking so simple, you can set up in 60 seconds. It will highlight any misspelled words in light red. Works great in conjunction with other CodeMirror modes, like GitHub Flavored Markdown.

[Demo](http://nextstepwebs.github.io/codemirror-spell-checker/)

![Screenshot](http://i.imgur.com/7yb5Nne.png)

## Install

Via [npm](https://www.npmjs.com/package/codemirror-spell-checker).
```
npm install codemirror-spell-checker --save
```

Via [bower](https://www.bower.io).
```
bower install codemirror-spell-checker --save
```

Via [jsDelivr](https://www.jsdelivr.com/projects/codemirror.spell-checker). *Please note, jsDelivr may take a few days to update to the latest release.*

```HTML
<link rel="stylesheet" href="https://cdn.jsdelivr.net/codemirror.spell-checker/latest/spell-checker.min.css">
<script src="https://cdn.jsdelivr.net/codemirror.spell-checker/latest/spell-checker.min.js"></script>
```

## Quick start
Once CodeMirror is installed and loaded, first provide CodeMirror Spell Checker with the correct CodeMirror function. Then, just set the primary mode to `"spell-checker"` and the backdrop mode to your desired mode. Be sure to load/require `overlay.min.js` if you haven't already.

```JS
CodeMirrorSpellChecker({
	codeMirrorInstance: CodeMirror,
});

CodeMirror.fromTextArea(document.getElementById("textarea"), {
	mode: "spell-checker",
	backdrop: "gfm" // Your desired mode
});
```

That's it!

## Customizing
You can customize the misspelled word appearance by updating the CSS. All misspelled words will have the `.cm-spell-error` class.

```CSS
.CodeMirror .cm-spell-error{
	/* Your styling here */
}
```

---
_Source: https://npm.io/package/codemirror-spell-checker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._