[BREAKGLASS] Append-only mirror of github.com/signalapp/quill
Go to file
Zihua Li 6b48eca201
Merge pull request #4099 from quilljs/zh-export-types
Expose types needed in public APIs
2024-04-04 20:05:28 +08:00
.github Change default branch 2024-02-03 21:42:15 +08:00
packages Expose Range type 2024-04-04 20:02:17 +08:00
scripts Fix release script for experimental version 2024-01-25 20:59:03 +08:00
.eslintignore Add release scripts 2024-01-14 22:50:46 +08:00
.gitignore Remove _develop folder 2023-11-28 12:11:53 +08:00
.npmignore Remove unused npm scripts for quill 2023-11-28 12:19:03 +08:00
CHANGELOG.md Expose Range type 2024-04-04 20:02:17 +08:00
CODE_OF_CONDUCT.md add code of conduct 2016-05-09 21:46:36 -07:00
LICENSE Update license years 2024-01-11 00:17:16 +08:00
package-lock.json 2.0.0-rc.4 2024-03-24 04:43:07 +00:00
package.json 2.0.0-rc.4 2024-03-24 04:43:07 +00:00
README.md Update package version in README 2024-03-26 10:08:43 +08:00
tsconfig.json Set up linter rules for importing 2024-02-12 11:43:06 +08:00

Note

This branch and README covers the upcoming 2.0 release. View 1.x docs here.

Quill Rich Text Editor

Quill Logo

QuickstartDocumentationDevelopmentContributingInteractive Playground

Build Status Version Downloads


Quill is a modern rich text editor built for compatibility and extensibility. It was created by Jason Chen and Byron Milligan and actively maintained by Slab.

To get started, check out https://quilljs.com/ for documentation, guides, and live demos!

Quickstart

Instantiate a new Quill object with a css selector for the div that should become the editor.

<!-- Include Quill stylesheet -->
<link
  href="https://cdn.jsdelivr.net/npm/quill@2.0.0-rc.4/dist/quill.snow.css"
  rel="stylesheet"
/>

<!-- 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">
  <p>Hello World!</p>
  <p>Some initial <strong>bold</strong> text</p>
  <p><br /></p>
</div>

<!-- Include the Quill library -->
<script src="https://cdn.jsdelivr.net/npm/quill@2.0.0-rc.4/dist/quill.js"></script>

<!-- Initialize Quill editor -->
<script>
  const quill = new Quill("#editor", {
    theme: "snow",
  });
</script>

Take a look at the Quill website for more documentation, guides and live playground!

Download

npm install quill@rc

CDN

<!-- Main Quill library -->
<script src="https://cdn.jsdelivr.net/npm/quill@2.0.0-rc.4/dist/quill.js"></script>

<!-- Theme included stylesheets -->
<link
  href="https://cdn.jsdelivr.net/npm/quill@2.0.0-rc.4/dist/quill.snow.css"
  rel="stylesheet"
/>
<link
  href="https://cdn.jsdelivr.net/npm/quill@2.0.0-rc.4/dist/quill.bubble.css"
  rel="stylesheet"
/>

<!-- Core build with no theme, formatting, non-essential modules -->
<link
  href="https://cdn.jsdelivr.net/npm/quill@2.0.0-rc.4/dist/quill.core.css"
  rel="stylesheet"
/>
<script src="https://cdn.jsdelivr.net/npm/quill@2.0.0-rc.4/dist/quill.core.js"></script>

Community

Get help or stay up to date.

License

BSD 3-clause