Skip to content

Automattic/quill

 
 

Repository files navigation

Webdriver Test Status

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.

Quickstart

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="sc-bold">Bold</button>
  <button class="sc-italic">Italic</button>
</div>

<!-- Create the editor container -->
<div id="editor">
  <div>Hello World!</div>
</div>

<!-- Include the Quill library -->
<script src="http://quilljs.com/js/quill.js"></script>

<!-- Initialize Quill editor -->
<script>
  var editor = new Quill('#editor');
  editor.addModule('toolbar', { container: '#toolbar' });
</script>

Local Development

Installation

npm install -g grunt-cli
npm install

Building

grunt build

Testing

grunt test - run tests with phantomjs
grunt test:karma - allows you to visit localhost:9876/debug.html for interactive testing
grunt test:remote - run tests on supported platforms on Sauce Labs
grunt test:coverage - run coverage tests using phantomjs

Community

Get help or stay up to date.

Contributing

Bug Reports

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.

Feature Requests

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!

Pull Requests

  1. Please check to make sure your plans fall within Quill's scope (likely through Github Issues).
  2. Fork Quill
  3. Branch off of the 'develop' branch.
  4. Implement your changes.
  5. Submit a Pull Request.

Important: By issuing a Pull Request you agree to allow the project owners to license your work under the terms of the License.

License

BSD 3-clause

About

A cross browser rich text editor with an API

Resources

License

Stars

Watchers

Forks

Packages

No packages published