# ng2-quill

> Angular2 component for rich text editor Quill

Latest version **0.0.6** (published 2016-12-12) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2016-12-12 |
| First published | 2016-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Known vulnerabilities | 0 (+22 in 4 direct dependencies) |
| Install scripts | no |
| Maintainers | killercodemonkey |

## Links

- npm: https://www.npmjs.com/package/ng2-quill
- npm.io page: https://npm.io/package/ng2-quill

## Dependencies (13)

- [rxjs](https://npm.io/package/rxjs.md) 5.0.0-rc.4
- [quill](https://npm.io/package/quill.md) ^1.1.6
- [core-js](https://npm.io/package/core-js.md) ^2.4.1
- [zone.js](https://npm.io/package/zone.js.md) ^0.7.2
- [ts-helpers](https://npm.io/package/ts-helpers.md) ^1.1.2
- [@angular/core](https://npm.io/package/@angular/core.md) ~2.2.3
- [@angular/http](https://npm.io/package/@angular/http.md) ~2.2.3
- [@angular/forms](https://npm.io/package/@angular/forms.md) ~2.2.3
- [@angular/common](https://npm.io/package/@angular/common.md) ~2.2.3
- [@angular/router](https://npm.io/package/@angular/router.md) ~3.1.0
- [@angular/compiler](https://npm.io/package/@angular/compiler.md) ~2.2.3
- [@angular/platform-browser](https://npm.io/package/@angular/platform-browser.md) ~2.2.3
- [@angular/platform-browser-dynamic](https://npm.io/package/@angular/platform-browser-dynamic.md) ~2.2.3

## Recent versions

- 0.0.6 (latest) — 2016-12-12
- 0.0.5 — 2016-11-30
- 0.0.4 — 2016-11-24

## README

# ng2-quill
Angular2 component for rich text editor Quill

<img src="https://cloud.githubusercontent.com/assets/2264672/20601381/a51753d4-b258-11e6-92c2-1d79efa5bede.png" width="200px">

ng2-quill is the angular 2 implementation of ngQuill.
This project was generated with [angular-cli](https://github.com/angular/angular-cli) version 1.0.0-beta.19-3.

## Examples
[demo-page](https://killercodemonkey.github.io/ng2-quill)

## Installation
- install QuillJS 1.1.5 `npm install ng2-quill`
- include bubble.css, snow.css in your index.html
- add `QuillModule` to your own NgModule: `node_modules/ng2-quill/src/quill/quill.module.ts`
- use `<quill-editor></quill-editor>` in your templates to add a default quill editor

## Config
- ngModel - set initial value or allow two-way databinding
- readOnly (true | false) if user can edit content
- formats - array of allowed formats/groupings
- modules - configure/disable quill modules, e.g toolbar or add custom toolbar via html element default is
```
{
  toolbar: [
    ['bold', 'italic', 'underline', 'strike'],        // toggled buttons
    ['blockquote', 'code-block'],

    [{ 'header': 1 }, { 'header': 2 }],               // custom button values
    [{ 'list': 'ordered'}, { 'list': 'bullet' }],
    [{ 'script': 'sub'}, { 'script': 'super' }],      // superscript/subscript
    [{ 'indent': '-1'}, { 'indent': '+1' }],          // outdent/indent
    [{ 'direction': 'rtl' }],                         // text direction

    [{ 'size': ['small', false, 'large', 'huge'] }],  // custom dropdown
    [{ 'header': [1, 2, 3, 4, 5, 6, false] }],

    [{ 'color': [] }, { 'background': [] }],          // dropdown with defaults from theme
    [{ 'font': [] }],
    [{ 'align': [] }],

    ['clean'],                                         // remove formatting button

    ['link', 'image', 'video']                         // link and image, video
  ]
};
```
- theme - bubble/snow, default is `snow`
- placeholder - placeholder text, default is `Insert text here ...`

## Outputs
- onEditorCreated - editor instance
- onContentChanged - text is updated
```
{
  editor: this.quillEditor,
  html: html,
  text: text
}
```

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