quilljs

    0.18.1 • Public • Published

    Quill Rich Text Editor Build Status Dependency Status

    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="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://quilljs.com/js/quill.js"></script>
     
    <!-- Initialize Quill editor -->
    <script>
      var editor = new Quill('#editor');
      editor.addModule('toolbar', { container: '#toolbar' });
    </script> 

    Local Development

    Quill's source is in Coffeescript and utilizes Browserify to organize its files.

    Installation

    npm install -g grunt-cli
    npm install
    

    Building

    grunt dist - compile and browserify
    grunt server - starts a local server that will build and serve assets on the fly
    

    Testing

    All tests assume the local server is running.

    grunt test - run tests with phantomjs
    grunt test:unit - runs javascript test suite with phantomjs
    grunt test:e2e - runs end to end tests with Webdriver + Chrome
    grunt test:coverage - run coverage tests using phantomjs
    grunt test:karma - runs karma on port 9876
    

    Check out Gruntfile.coffee and config/grunt for more testing options.

    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.

    Pull requests will not be accepted without adhering to the following:

    1. Conform to existing coding styles.
    2. New functionality are accompanied by tests.
    3. Serve a single atomic purpose (add one feature or fix one bug)
    4. 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.

    License

    BSD 3-clause

    Install

    npm i quilljs

    Homepage

    quilljs.com

    DownloadsWeekly Downloads

    675

    Version

    0.18.1

    License

    BSD-3-Clause

    Last publish

    Collaborators

    • jhchen
    • theycallmeswift