npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-quill-spell-checker

v1.9.4

Published

Integrate any spell checker on Quill.js editor

Downloads

116

Readme

react-quill-spell-checker

Integrate any spell checker on Quill.js editor

NPM JavaScript Style Guide

Demo

Example video

A live demo can be found at https://anderneath.github.io/react-quill-spell-checker. The source code for a complete example with react-quill can be found in /example.

Features

  • [x] SpellChecker integration
  • [x] TypeScript typed
  • [x] Easy integration with Quill.js
  • [x] Custom server support
  • [x] Custom CSS support
  • [x] Server spam prevention

Install

npm install --save react-quill-spell-checker

Usage

import React, { useState } from 'react'
import ReactQuill, { Quill } from 'react-quill'
import 'react-quill/dist/quill.snow.css'
import registerQuillSpellChecker from 'react-quill-spell-checker'

registerQuillSpellChecker(Quill)

<ReactQuill
  modules={{
    spellChecker: {
      // options here
    }
  }}
/>

Using this module will change the contents of the editor to add control elements for spell checking and grammar checking. Look at "Getting the contents of the editor" for information on how to use the contents of the editor.

registerQuillSpellChecker(Quill)

This package exports a default function to register the SpellChecker module to Quill.js.

import Quill from 'quill'
import registerQuillSpellChecker from 'react-quill-spell-checker'

registerQuillSpellChecker(Quill)

This adds the SpellChecker module and the suggestion blot element to Quill.js so they can be used on any editor using that Quill import.

Options

Options can be provided into the spellChecker option of the Quill module.

<ReactQuill
  modules={{
    spellChecker: {
      // options here
    }
  }}
/>

Available options are:

  • api: (default uses LanguageTool API) The Spell Checker API params, including url, body (usually contains the text and language required params for the API to work), headers, method, mode and mapResponse (used to map/transform the response of the API endpoint so that the spell checker understands).
  • disableNativeSpellcheck (default true): Disable the native spellchecker on the editor to prevent two conflicting systems trying to underline the same words
  • cooldownTime (default 3000): The time after a user stops typing before the SpellChecker server is queried
  • showLoadingIndicator (default true): Show a loading indicator when the SpellChecker server is queried in the bottom right corner of the editor

API

You can use any spell checker API, such as LanguageTool, if you plan on using the library for larger sites, please consider using your own server.

cooldownTime

To prevent spamming the server, a cooldown time is used. By default, this is set to 3000 milliseconds so the server is queries only once the user stopped typing 3s ago.

Getting the contents of the editor

This library adds a custom blot element to the editor that is used to add formatting and click listeners. This transforms content like this:

<p>This text conatins typos,, that should get corrected by SpellChecker</p>

into this:

<p>
  This text
  <quill-spck-match
    data-offset="10"
    data-length="8"
  >
    conatins
  </quill-spck-match>
  typos
  <quill-spck-match
    data-offset="24"
    data-length="2"
  >
    ,,
  </quill-spck-match>
  that should get corrected by SpellChecker
</p>

When getting the contents of the editor, the custom blot elements need to be removed. For this, the library exposes a getCleanedHtml method that removes the elements from an HTML string.

import { getCleanedHtml } from 'react-quill-spell-checker'

const dirtyContents = quill.root.innerHTML
const cleanedContents = getCleanedHtml(quillHtml)

Alternatively, removeSuggestionBoxes can be used to remove the custom blot elements from the editor's content itself. Please note that this will trigger an update of the editor which will re-trigger the module to add them back again.

import { removeSuggestionBoxes } from "react-quill-spell-checker";

const quill = new Quill(...);
removeSuggestionBoxes(quill);

Customizing design

By default, the library uses a simple, light-mode design for the suggestion boxes. By overriding the CSS classes used you can customize the design. Take a look at /src/QuillSpellChecker.css for all styles and classes used by the default design

Development

  1. Clone this repository
  2. Run npm install in the root directory and /example (npm i && cd example && npm i)
  3. Run npm start in /example to start development using the example project

License

MIT © anderneath


This project is created using create-react-hook.