Neurosis Prevention Mechanism
    Wondering what’s next for npm?Check out our public roadmap! »

    codemirror-spell-checker-inkdrop

    1.2.0 • Public • Published

    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

    Screenshot

    Install

    Via npm.

    npm install codemirror-spell-checker --save
    

    Via bower.

    bower install codemirror-spell-checker --save
    

    Via jsDelivr. Please note, jsDelivr may take a few days to update to the latest release.

    <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.

    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.

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

    Install

    npm i codemirror-spell-checker-inkdrop

    DownloadsWeekly Downloads

    3

    Version

    1.2.0

    License

    MIT

    Last publish

    Collaborators

    • avatar