Note: This branch and README is intended for the upcoming 1.0 release which has made many changes to the development toolchain. Some instructions here may be out of date or become out of date as development on 1.0 progresses.
Quill is a modern rich text editor built for compatibility and extensibility. It was created by Jason Chen and Byron Milligan and open sourced by Salesforce.com.
To get started, check out the Quill Github Page or jump straight into the demo.
Instantiate a new Quill object with a css selector for the div that should become the editor.
<!-- Create the toolbar container -->
<div id="toolbar">
<button class="ql-bold">Bold</button>
<button class="ql-italic">Italic</button>
</div>
<!-- Create the editor container -->
<div id="editor">
<div>Hello World!</div>
</div>
<!-- Include the Quill library -->
<script src="http://cdn.quilljs.com/latest/quill.js"></script>
<!-- Initialize Quill editor -->
<script>
var editor = new Quill('#editor');
editor.addModule('toolbar', { container: '#toolbar' });
</script>There are a number of ways to download the latest or versioned copy of Quill.
- npm:
npm install quill - bower:
bower install quill - tar: https://github.com/quilljs/quill/releases
<link rel="stylesheet" href="//cdn.quilljs.com/0.19.10/quill.snow.css" />
<script src="//cdn.quilljs.com/0.19.10/quill.min.js"></script>Quill's source is in ES6 and utilizes Webpack to organize its files.
npm install -g gulp
npm install
gulp build - compiles quill and examples into .build/
gulp server - starts a local server that will build and serve assets on the fly
gulp dev - same as `gulp server` and also starts the test server proxied through /karma
With the local server (gulp server) running you can try out some minimal examples on:
Quill releases also contain these examples as built static files you can try without needing to run the local development server.
With the dev server (gulp dev) you can also run the unit tests with your browser:
gulp test:unit - runs javascript test suite with Chrome
gulp test:e2e - runs end to end tests with Webdriver + Chrome
gulp test:coverage - run tests measuring coverage with Chrome
Tests are run by Karma and Protractor using Jasmine. Check out gulpfile.js and config/test.js for more testing options.
Get help or stay up to date.
- Follow @quilljs on Twitter
- Ask questions on Stack Overflow (tag with quill)
- If a private channel is required, you may also email [email protected]
Search through Github Issues to see if the bug has already been reported. If so, please comment with any additional information about the bug.
For new issues, create a new issue and tag with the appropriate browser tag. Include as much detail as possible such as:
- Detailed description of faulty behavior
- Affected platforms
- Steps for reproduction
- Failing test case
The more details you provide, the more likely we or someone else will be able to find and fix the bug.
We welcome feature requests. Please make sure they are within scope of Quill's goals and submit them in Github Issues tagged with the 'feature' tag. The more complete and compelling the request, the more likely it will be implemented. Garnering community support will help as well!
- Please check to make sure your plans fall within Quill's scope (likely through Github Issues).
- Fork Quill
- Branch off of the 'develop' branch.
- Implement your changes.
- Submit a Pull Request.
Pull requests will not be accepted without adhering to the following:
- Conform to existing coding styles.
- New functionality are accompanied by tests.
- Serve a single atomic purpose (add one feature or fix one bug)
- Introduce only changes that further the PR's singular purpose (ex. do not tweak an unrelated config along with adding your feature).
Important: By issuing a Pull Request you agree to allow the project owners to license your work under the terms of the License.
BSD 3-clause