See a live demo.
- Quick start
- Styles and themes
- Upgrading to React-Quill v1.0.0
- Bundling with Webpack
- API reference
- Building and testing
- Changelog
- Contributors
- License
💯 React Quill now supports Quill v1.0.0!
Thanks to @clemmy and @alexkrolick for landing this much-awaited change. There are many breaking changes, so be sure to read the migration guide.
🏵 Welcoming @alexkrolick to the team!
His contributions have been incredible so far, and his passion and dedication will bring some much-deserved love to this project.
var MyComponent = React.createClass({
onTextChange: function(value) {
this.setState({ text:value });
},
render: function() {
return (
<ReactQuill value={this.state.text}
onChange={this.onTextChange} />
);
},
});/*
Include `quill.snow.css` to use the editor's standard theme. For example,
depending on the structure of your app, you could do something like this:
<link rel="stylesheet" href="node_modules/react-quill/dist/quill.snow.css">
*/
var MyComponent = React.createClass({
modules: {
toolbar: [
[{ 'header': [1, 2, false] }],
['bold', 'italic', 'underline','strike', 'blockquote'],
[{'list': 'ordered'}, {'list': 'bullet'}, {'indent': '-1'}, {'indent': '+1'}],
['link', 'image'],
['clean']
],
},
formats: [
'header',
'bold', 'italic', 'underline', 'strike', 'blockquote',
'list', 'bullet', 'indent',
'link', 'image'
],
render: function() {
return (
<div className="text-editor">
<ReactQuill theme="snow"
modules={this.modules}
formats={this.formats}>
<div key="editor"
ref="editor"
className="quill-contents my-class-name"
dangerouslySetInnerHTML={{__html:this.state.editorContent}}/>
</ReactQuill>
</div>
);
},
});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.
The Quill editor supports themes.
It includes a full-fledged theme, called snow, that is Quill's standard appearance, and a base theme containing only the bare essentials to allow modules like toolbars or tooltips to work.
These stylesheets can be found in the Quill distribution, but for convenience they are also linked among React Quill's dists. In a common case you would activate a theme like this:
<ReactQuill theme="snow" />
And then link the appropriate stylesheet:
<link rel="stylesheet" href="node_modules/react-quill/dist/quill.snow.css">
This may vary depending how application is structured, directories or otherwise. For example, if you use a CSS pre-processor like SASS, you may want to import that stylesheet inside your own.
Please note that many migration steps to Quill v1.0 may also apply.
With v1.0.0, Quill adopted a new [toolbar configuration format]((https://quilljs.com/docs/modules/toolbar/), to which React Quill will delegates all toolbar functionality, and which is now the preferred way to customize the toolbar.
Previously, toolbar properties could be set by passing a toolbar prop to React Quill. Pass the same options as modules.toolbar instead.
+ modules: {
toolbar: [
...
],
+ },
<ReactQuill
- toolbar={this.toolbar}
+ modules={this.modules}
/>If you provided your own HTML toolbar component, you can still do the same:
+ modules: {
+ toolbar: '#my-toolbar-component',
+ },
<ReactQuill
- toolbar="#my-toolbar-component"
+ modules={this.modules}
/>Previously, React Quill would create a custom HTML toolbar for you if you passed a configuration object as the toolbar prop. This will not happen anymore. You can still create a ReactQuill.Toolbar explicitly:
+ modules: {
+ toolbar: '#my-quill-toolbar',
+ },
+ <ReactQuill.Toolbar
+ id='my-quill-toolbar'
+ items={this.oldStyleToolbarItems}
+ />
<ReactQuill
- toolbar={this.oldStyleToolbarItems}
+ modules={this.modules}
/>However, consider switching to the new Quill format instead, or provide your own toolbar component.
React Quill now follows the Quill toolbar format closely. See the Quill toolbar documentation for a complete reference on all supported options.
Previously, it was possible to provide custom formats to the formats prop. Use Parchment to provide new formats instead.
Previously, it was allowed to inject CSS styles by providing an object to the styles property. This option has been removed from Quill 1.0, and support for it in React Quill has gone as well. If you need to inject styles, link an external stylesheet instead.
See the Quill Release Notes.
This property previously set the frequency with which Quill polled the DOM for changes. It does not have any effect anymore, and can safely be removed from the props.
Quill ships only a pre-built javascript file, so Webpack will complain:
Error: ./~/react-quill/~/quill/dist/quill.js
Critical dependencies:
6:478-485 This seems to be a pre-built javascript file. Though this is possible, it's not recommended. Try to require the original source to get better results.
@ ./~/react-quill/~/quill/dist/quill.js 6:478-485
The warning is harmless, but if you want to silence it you can avoid parsing Quill by adding this to your Webpack configuration:
module: {
// Shut off warnings about using pre-built javascript files
// as Quill.js unfortunately ships one as its `main`.
noParse: /node_modules\/quill\/dist/
}See #7 for more details.
ReactQuill.Mixin
: Provides the bridge between React and Quill. ReactQuill implements this mixin; in the same way you can use it to build your own component, or replace it to implement a new core for the default component.
ReactQuill.Toolbar
: The component that renders the custom ReactQuill toolbar. The default collection of items and color swatches is available as ReactQuill.Toolbar.defaultItems and ReactQuill.Toolbar.defaultColors respectively.
ReactQuill.Quill
: The Quill namespace on which you can call registerModule and such.
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. Note that due to limitations in Quill, this is actually a semi-controlled mode, meaning that the edit is not prevented, but changing value will still replace the contents.
defaultValue
: Initial value for the editor as an uncontrolled component.
readOnly
: If true, the editor won't allow changing its contents.
placeholder
: The default value for the empty editor.
modules
: An object specifying which modules are enabled, and their configuration. The editor toolbar is a commonly customized module. See the modules section over the Quill documentation for more information on what modules are available.
formats
: An array of formats to be enabled during editing. All implemented formats are enabled by default. See Formats for a list.
style
: An object with custom CSS rules to apply on the editor's container. Rules should be in React's "camelCased" naming style.
theme
: The name of the theme to apply to the editor. Defaults to base.
bounds
: Selector or DOM element used by Quill to constrain position of popups. Defaults to document.body.
onChange(content, delta, source, editor)
: Called back with the new contents of the editor after change. It will be passed the HTML contents of the editor, a delta object expressing the change-set itself, the source of the change, and finally a read-only proxy to editor accessors such as getText().
onChangeSelection(range, source, editor)
: Called back with the new selected range, or null when unfocused. It will be passed the selection range, the source of the change, and finally a read-only proxy to editor accessors such as getBounds().
onKeyPress(event)
: Called after a key has been pressed and released.
: Note that, like its native counterpart, this won't be called for special keys such as shift or enter. If you need those, hook onto onKeyDown or onKeyUp.
onKeyDown(event)
: Called after a key has been pressed, but before it is released.
: Note that, due to how Quill works, it's possible that you won't receive events for keys such as enter, backspace or delete. If that's the case, try hooking onto onKeyUp instead.
onKeyUp(event)
: Called after a key has been released.
If you have a ref to a ReactQuill node, you will be able to invoke the following methods:
focus()
: Focuses the editor.
blur()
: Removes focus from the editor.
getEditor()
: Returns the Quill instance that backs the editor. While you can freely use this to access methods such as getText(), please avoid from imperatively manipulating the instance.
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
This release adds support for Quill v1.0.0+.
- Updated to support Quill v1.0.0+ (@clemmy, @alexkrolick)
- Bundling Quill with ReactQuill (@clemmy)
- Bundling CSS files in the NPM package
- Deprecated
toolbarproperty and component - Deprecated the
stylesproperty - Deprecated custom formats via the
formatsproperty - Deprecated the
pollIntervalproperty - Rerendering on
styleproperty change (@lavrton) - Improved docs for
bounds, which now rerenders on change - Performing deep props comparison to avoid rerenders
- Fixed the unprivileged editor not returning values
- Restoring selection event after text change
- Fixed the order of parameters in change events (@webcarrot)
- Using 'core' instead of 'base' CSS (@alexkrolick)
- Added support for the
placeholderproperty (@alexkrolick) - Enable/disable editor using top-level Quill API (@alexkrolick)
- Prevent whitespace issues when initializing the editor (@bobrafie)
- Using buttons instead of spans for toolbar actions (@clemmy)
- Removed getHtml from unprivileged editor (@clemmy)
- Fixed calculations for range fields (@clemmy)
- Removed deprecated destroy functionality (@clemmy)
- Added return statement to proxy editor methods (@druti)
- Inline styles support for Quill Toolbar (@e-jigsaw)
- Fixed custom font size definitions (@clemmy)
- Support for bullet and ordered lists in toolbar (@clemmy)
- Updated the toolbar alignment section (@clemmy)
- Updated rendering of toolbar actions (@clemmy)
- Improved toolbar renderChoices implementation (@zhang-z)
- Fixed use of
defaultValuein Toolbar selects
- Added contents of
distto NPM package.
This release adds support for React 0.14.
- React 0.14 support (@jacktrades, #49)
- Removed shims for React 0.12 and 0.13
- Bumped Quill.js to v0.20.1
- Normal and smaller sizes are not swapped anymore. (#63)
- Various toolbar choice items are now correctly ordered.
- Added image tooltips to the default set of modules (@kairxa, #54)
- Fixed extra white-space in classnames (@asiniy, #67)
- Published the Quill namespace on ReactQuill (@Sajam, #60)
- Quill stylesheets are now linked to
dist/for convenience. (#70) - Exposed editor accessor methods in change events. (#33)
React Quill would not be where it is today without the contributions of many people, which we are incredibly grateful for:
- @zenoamaro (maintainer)
- @alexkrolick (maintainer)
- @clemmy
- @asiniy
- @webcarrot
- @druti
- @e-jigsaw
- @zhang-z
- @Sajam
- @0bird512
- @jacktrades
- @1000hz
- @kkerr1
- @csk157
- @Janekk
- @AndyTheGiant
- @chrismcv
- React 0.14 support
- Quill v1.0.0+ support
- ES6 rewrite
- Tests!
The MIT License (MIT)
Copyright (c) 2016, 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.