# quill

> Your powerful, rich text editor

Latest version **2.0.3** (published 2024-11-30) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install quill
pnpm add quill
yarn add quill
bun add quill
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; high quality score; popular repo.

Warnings: low downloads; has vulnerabilities.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2024-11-30 |
| First published | 2012-03-25 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 2.9 MB |
| Known vulnerabilities | 1 |
| Install scripts | no |
| GitHub stars | 47348 |
| Author | Jason Chen |
| Maintainers | luin, jhchen |
| Keywords | quill, editor, rich text, wysiwyg, operational transformation, ot, framework |

## Links

- npm: https://www.npmjs.com/package/quill
- Repository: https://github.com/slab/quill
- Homepage: https://quilljs.com
- Issues: https://github.com/slab/quill/issues
- npm.io page: https://npm.io/package/quill

## Dependencies (4)

- [lodash-es](https://npm.io/package/lodash-es.md) ^4.17.21
- [parchment](https://npm.io/package/parchment.md) ^3.0.0
- [quill-delta](https://npm.io/package/quill-delta.md) ^5.1.0
- [eventemitter3](https://npm.io/package/eventemitter3.md) ^5.0.1

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 2.0.3 (latest) — 2024-11-30
- 0.0.0-experimental-1523aa0d1-20241129 (experimental) — 2024-11-29
- 2.0.0-rc.5 (rc) — 2024-04-04
- 2.0.0-beta.2 (beta) — 2024-01-30
- 2.0.0-dev.4 (dev) — 2020-04-10
- 2.0.2 — 2024-05-13
- 2.0.1 — 2024-05-01
- 2.0.0 — 2024-04-17
- 0.0.0-experimental-6acd59e4d-20240404 — 2024-04-04
- 0.0.0-experimental-fc834faaf-20240404 — 2024-04-04
- 2.0.0-rc.4 — 2024-03-24
- 0.0.0-experimental-bbb69eede-20240320 — 2024-03-20
- 0.0.0-experimental-dd0792975-20240318 — 2024-03-18
- 0.0.0-experimental-5b72e1af6-20240316 — 2024-03-16
- 2.0.0-rc.3 — 2024-03-16
- … 81 more at https://npm.io/package/quill/versions

## README

<h1 align="center">
  <a href="https://quilljs.com/" title="Quill">Quill Rich Text Editor</a>
</h1>
<p align="center">
  <a href="https://quilljs.com/" title="Quill"><img alt="Quill Logo" src="https://quilljs.com/assets/images/logo.svg" width="180"></a>
</p>
<p align="center">
  <a title="Documentation" href="https://quilljs.com/docs/quickstart"><strong>Documentation</strong></a>
  &#x2022;
  <a title="Development" href="https://github.com/slab/quill/blob/main/.github/DEVELOPMENT.md"><strong>Development</strong></a>
  &#x2022;
  <a title="Contributing" href="https://github.com/slab/quill/blob/main/.github/CONTRIBUTING.md"><strong>Contributing</strong></a>
  &#x2022;
  <a title="Interactive Playground" href="https://quilljs.com/playground/"><strong>Interactive Playground</strong></a>
</p>
<p align="center">
  <a href="https://github.com/slab/quill/actions" title="Build Status"><img src="https://github.com/slab/quill/actions/workflows/main.yml/badge.svg" alt="Build Status"></a>
  <a href="https://npmjs.com/package/quill" title="Version"><img src="https://img.shields.io/npm/v/quill.svg" alt="Version"></a>
  <a href="https://npmjs.com/package/quill" title="Downloads"><img src="https://img.shields.io/npm/dm/quill.svg" alt="Downloads"></a>
</p>

<hr/>

[Quill](https://quilljs.com/) is a modern rich text editor built for compatibility and extensibility. It was created by [Jason Chen](https://twitter.com/jhchen) and [Byron Milligan](https://twitter.com/byronmilligan) and actively maintained by [Slab](https://slab.com).

To get started, check out [https://quilljs.com/](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.

```html
<!-- Include Quill stylesheet -->
<link
  href="https://cdn.jsdelivr.net/npm/quill@2/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/dist/quill.js"></script>

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

Take a look at the [Quill](https://quilljs.com/) website for more documentation, guides and [live playground](https://quilljs.com/playground/)!

## Download

```shell
npm install quill
```

### CDN

```html
<!-- Main Quill library -->
<script src="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.js"></script>

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

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

## Community

Get help or stay up to date.

- [Contribute](https://github.com/slab/quill/blob/main/.github/CONTRIBUTING.md) on [Issues](https://github.com/slab/quill/issues)
- Ask questions on [Discussions](https://github.com/slab/quill/discussions)

## License

BSD 3-clause

---
_Source: https://npm.io/package/quill · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._