Napoleonic Political Magnificence
    Have ideas to improve npm?Join in the discussion! »

    @inkdropapp/codemirror-spell-checker

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

    Inspired by fantastic work done by Wes Cossick.

    Demo

    Screenshot

    It works only on Electron apps since it depends on NodeJS.

    Install

    Via npm.

    npm install @inkdropapp/codemirror-spell-checker --save
    

    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.

    import SpellChecker from '@inkdropapp/codemirror-spell-checker'
    
    SpellChecker(CodeMirror)
    
    CodeMirror.fromTextArea(document.getElementById("textarea"), {
      mode: "spell-checker",
      backdrop: "gfm",        // Your desired mode
      spellCheckLang: "en_US"
    });

    That's it!

    Other languages

    Some languages are tested and bundled in the data directory. It supports other languages by downloading the dictionary files from titoBouzout/Dictionaries. In order to use another language instead of en_US you just have to provide a language name listed in the above repository like so:

    CodeMirror.fromTextArea(document.getElementById("textarea"), {
      mode: "spell-checker",
      backdrop: "gfm",
      spellCheckLang: "en_AU"
    });

    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 @inkdropapp/codemirror-spell-checker

    DownloadsWeekly Downloads

    26

    Version

    1.0.4

    License

    MIT

    Unpacked Size

    5.22 MB

    Total Files

    27

    Last publish

    Collaborators

    • avatar