A Quill component for React.

See the live demo.

1. Quick start
2. API reference
3. Building and testing
4. Changelog
5. License

1. Use straight away:

   /*
   Include `quill.base.css` to give the editor some basic styles it needs.
   You can find the _base_ theme in the quill distribution or inside
   `node_modules`.
   */
   
   var React = require('react');
   var ReactQuill = require('react-quill');
   
   var MyComponent = React.createClass({
     /* ... */
   
     render: function() {
       return (
         <ReactQuill value={this.state.value} />
       );
     }
   });

2. Customize a few settings:

   /*
   Include a theme like `quill.snow.css` and activate it in the
   configuration like shown below. You can find the _snow_ theme in the
   quill distribution or inside `node_modules`.
   */
   
   var MyComponent = React.createClass({
     /* ... */
   
     onTextChange: function(value) {
       this.setState({ text:value });
     },
   
     render: function() {
       return (
         <ReactQuill theme="snow"
                     value={this.state.text}
                     onChange={this.onTextChange} />
       );
     }
   });

3. Custom controls:

   var MyComponent = React.createClass({
     /* ... */
   
     render: function() {
       return (
         <ReactQuill>
           <ReactQuill.Toolbar key="toolbar"
                               ref="toolbar"
                               items={ReactQuill.Toolbar.defaultItems} />
           <div key="editor"
                ref="editor"
                className="quill-contents"
                dangerouslySetInnerHTML={{__html:this.getEditorContents()}} />
         </ReactQuill>
       );
     }
   });

4. Mixing in:

   var MyComponent = React.createClass({
     mixins: [ ReactQuill.Mixin ],
   
     componentDidMount: function() {
       var editor = this.createEditor(
         this.getEditorElement(),
         this.getEditorConfig()
       );
       this.setState({ editor:editor });
     },
   
     componentWillReceiveProps: function(nextProps) {
       if ('value' in nextProps && nextProps.value !== this.props.value) {
         this.setEditorContents(this.state.editor, nextProps.value);
       }
     },
   
     /* ... */
   });

   See component.js for a fully fleshed-out example.

ReactQuill accepts a few props:

id : ID to be applied to the DOM element.

className : Classes to be applied to the DOM element.

value : Value for the editor as a controlled component.

defaultValue : Initial value for the editor as an uncontrolled component.

readOnly : If true, the editor won't allow changing its contents.

toolbar : A list of toolbar items to use as custom configuration for the toolbar. Defaults (that also double as reference) are available as ReactQuill.Toolbar.defaultItems and ReactQuill.Toolbar.defaultColors. See also the Toolbar module over the Quill documentation for more information on the inner workings.

formats : An array of formats to be enabled during editing. All implemented formats are enabled by default. See Formats for a list.

styles : An object with custom CSS styles to be added to the editor. See configuration for details.

theme : The name of the theme to apply to the editor. Defaults to base.

pollInterval : Interval in ms between checks for local changes in editor contents.

onChange(value) : Called back with the new contents of the editor after change.

You can run the automated test suite:

$ npm test

And build a minificated version of the source:

$ npm run build

More tasks are available on the Makefile:

lint: lints the source
spec: runs the test specs
coverage: runs the code coverage test
test: lint, spec and coverage threshold test
build: builds the minified version

• The pre-compiled distributable is not shipped with the NPM package anymore. Should fix #2.
• Sourcemaps are now emitted for both distributables, as separate files.
• Avoiding parsing Quill as it ships with a pre-built main.

• Added support for toolbar separators.
• Added support for font family selectors.
• Updated the default toolbar to match Quill's.
• Updated Quill to v0.19.12.

Full changelog

• Support updates in editor life-cycle
• First-class support for modules
• Better API for custom controls?
• Delta updates

The MIT License (MIT)

Copyright (c) 2015, zenoamaro [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.