ngx-quill

What is ngx-quill?

ngx-quill is an Angular component for the Quill rich text editor. It provides a simple way to integrate Quill into Angular applications, allowing for rich text editing capabilities with a variety of customization options.

What are ngx-quill's main functionalities?

Basic Integration

This code demonstrates how to integrate the Quill editor into an Angular component using ngx-quill. The editor's content is bound to the `editorContent` variable using Angular's two-way data binding.

<quill-editor [(ngModel)]="editorContent"></quill-editor>

Custom Toolbar

This code shows how to customize the toolbar of the Quill editor. The toolbar is configured to include buttons for bold, italic, and list formatting options.

<quill-editor [modules]="{ toolbar: [['bold', 'italic'], [{ 'list': 'ordered'}, { 'list': 'bullet' }]] }"></quill-editor>

Form Integration

This example demonstrates how to integrate the Quill editor with Angular forms. The editor is bound to a form control named `editor` within a reactive form.

<form [formGroup]="form"><quill-editor formControlName="editor"></quill-editor></form>

Content Formatting

This code shows how to apply custom styles and enable syntax highlighting in the Quill editor. The editor's height is set to 200 pixels, and syntax highlighting is enabled.

<quill-editor [styles]="{ height: '200px' }" [modules]="{ syntax: true }"></quill-editor>

Other packages similar to ngx-quill

ngx-editor

ngx-editor is another Angular rich text editor that provides similar functionalities to ngx-quill. It offers a simple API for integrating a rich text editor into Angular applications, with support for custom toolbars and form integration. Compared to ngx-quill, ngx-editor is more lightweight but may have fewer customization options.

angular-editor

angular-editor is a lightweight Angular WYSIWYG editor that provides basic rich text editing capabilities. It is easy to integrate and use, making it a good choice for simple use cases. However, it may lack some of the advanced features and customization options available in ngx-quill.

ng2-quill-editor

ng2-quill-editor is another Angular wrapper for the Quill editor. It offers similar functionalities to ngx-quill, including support for custom toolbars and form integration. The main difference is in the implementation and API design, which may vary slightly between the two packages.

README

ngx-quill

ngx-quill is an angular (>=2) module for the Quill Rich Text Editor containing all components you need.

Donate/Support

If you like my work, feel free to support it. Donations to the project are always welcomed :)

PayPal: PayPal.Me/bengtler

BTC Wallet Address: 3QVyr2tpRLBCw1kBQ59sTDraV6DTswq8Li

ETH Wallet Address: 0x394d44f3b6e3a4f7b4d44991e7654b0cab4af68f

LTC Wallet Address: MFif769WSZ1g7ReAzzDE7TJVqtkFpmoTyT

XRP Wallet Address: rXieaAC3nevTKgVu2SYoShjTCS2Tfczqx?dt=159046833

XLM Wallet Address: GBHSSR4KDXGVD6OGR2577TW2OUX6ZMS5V3ZIBUXT4ZETSTZHMPFMGF3E

Examples

• Advanced Demo
  • integration of quill-emoji
  • integration of quill-mention
  • integration of quill-image-resize
  • custom word count module
  • custom toolbar with custom fonts and formats, toolbar position
  • show the differences between sanitizing and not sanitizing your content if your content format is html
  • usage of different content formats
  • template-driven and reactive forms
  • code + syntax highlighting
  • formulas
  • custom key-bindings, e.g. shift + b for bold
  • dynamic styles and placeholder
  • toggle readonly
  • bubble toolbar
  • activate formats after editor initialisation, e.g. rtl direction
  • present quilljs content with the quill-view and quill-view-html component
• Ionic Demo

Compatibility to Angular Versions

Angular	ngx-quill	supported/maintained
v9	>= 8.0.0	until October/November 2019
v8	>= 5.2.0	until Nov 22, 2020
v7	>= 4.0.0, < 8.0.0	until Apr 18, 2020
v6	>= 3.0.0	no
v5	> 1.6.0	no
v4	< 1.6.0	no

Installation

• npm install ngx-quill
• for projects using Angular < v5.0.0 install npm install ngx-quill@1.6.0
• install @angular/core, @angular/common, @angular/forms, @angular/platform-browser, quill, and rxjs - peer dependencies of ngx-quill
• install parchment and quill-delta as peer dependencies for custom typings of Quill instances, Range and Delta
• include theme stylings: bubble.css, snow.css of quilljs in your index.html, or add them in your css/scss files with @import statements, or add them external stylings in your build process.

For standard webpack, angular-cli and tsc builds

• import QuillModule from ngx-quill:

import { QuillModule } from 'ngx-quill'

• add QuillModule to the imports of your NgModule:

@NgModule({
  imports: [
    ...,

    QuillModule.forRoot()
  ],
  ...
})
class YourModule { ... }

• use <quill-editor></quill-editor> in your templates to add a default quill editor
• do not forget to include quill + theme css in your buildprocess, module or index.html!
• for builds with angular-cli >=6 only add quilljs to your scripts or scripts section of angular.json, if you need it as a global :)!

HINT: If you are using lazy loading modules, you have to add QuillModule.forRoot() to your imports in your root module to make sure the Config services is registered.

For SystemJS builds (Config)

• add quill and ngx-quill to your paths:

paths: {
  ...
  'ngx-quill': 'node_modules/ngx-quill/bundles/ngx-quill.umd.js',
  'quill': 'node_modules/quill/dist/quill.js'
}

• set format and dependencies in packages:

packages: {
  'ngx-quill': {
    format: 'cjs',
    meta: {
      deps: ['quill']
    }
  },
  'quill': {
    format: 'cjs'
  }
}

• follow the steps of For standard webpack and tsc builds

Global Config

It is possible to set custom default modules and Quill config options with the import of the QuillModule.forRoot().

@NgModule({
  imports: [
    ...,

    QuillModule.forRoot({
      modules: {
        syntax: true,
        toolbar: [...]
      }
    })
  ],
  ...
})
class YourModule { ... }

If you want to use the syntax module follow the Syntax Highlight Module Guide.

See Quill Configuration for a full list of config options.

The QuillModule exports the defaultModules if you want to extend them :).

QuillEditorComponent

Hint

Ngx-quill updates the ngModel or formControl for every user change in the editor. Checkout the QuillJS Source parameter of the text-change event.

If you are using the editor reference to directly manipulate the editor content and want to update the model, pass 'user' as the source parameter to the QuillJS api methods.

Config

• ngModel - set initial value or allow two-way databinding for template driven forms
• formControl/formControlName - set initial value or allow two-way databinding for reactive forms
• readOnly (true | false) if user can edit content
• formats - array of allowed formats/groupings
• format - model format - default: html, values: html | object | text | json, sets the model value type - html = html string, object = quill operation object, json = quill operation json, text = plain text
• 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
• sanitize - uses angulars DomSanitizer to santize html values - default: false, boolean (only for format="html")
• styles - set a styles object, e.g. [styles]="{height: '250px'}"
• placeholder - placeholder text, default is Insert text here ...
• bounds - boundary of the editor, default document.body, pass 'self' to attach the editor element
• maxLength - add validation for maxlength - set model state to invalid and add ng-invalid class
• minLength - add validation for minlength - set model state to invalid and add ng-invalid class, only set invalid if editor text not empty --> if you want to check if text is required --> use the required attribute
• trimOnValidation - trim trailing|leading newlines on validation run for required, min- and maxLength, default false
• required - add validation as a required field - [required]="true" - default: false, boolean expected (no strings!)
• strict - default: true, sets editor in strict mode
• scrollingContainer - default '.ql-editor', allows to set scrolling container
• use custom-options for adding for example custom font sizes --> this overwrites this options globally !!!
• possbility to create a custom toolbar via projection slot [quill-editor-toolbar]:

<quill-editor>
  <div quill-editor-toolbar>
    <span class="ql-formats">
      <button class="ql-bold" [title]="'Bold'"></button>
    </span>
    <span class="ql-formats">
      <select class="ql-align" [title]="'Aligment'">
        <option selected></option>
        <option value="center"></option>
        <option value="right"></option>
        <option value="justify"></option>
      </select>
      <select class="ql-align" [title]="'Aligment2'">
        <option selected></option>
        <option value="center"></option>
        <option value="right"></option>
        <option value="justify"></option>
      </select>
    </span>
  </div>
</quill-editor>

• customToolbarPosition - if you are working with a custom toolbar you can switch the position :). - default: top, possible values top, bottom
• debug - set log level warn, error, log or false to deactivate logging, default: warn
• trackChanges - check if only user (quill source user) or all change should be trigger model update, default user. Using all is not recommended, it cause some unexpected sideeffects.
• preserveWhitespace - default: false - possbility to use a pre-tag instead of a div-tag for the contenteditable area to preserve duplicated whitespaces | caution if used with syntax plugin Related issue
• classes - a space separated list of CSS classes that will be added onto the editor element

Full Quill Toolbar HTML

Outputs

• onEditorCreated - editor instance
• Use this output to get the editor instance and use it directly. After this output has called the component is stable and all listeners are binded

editor // Quill

• onContentChanged - text is updated

{
  editor: editorInstance, // Quill
  html: html, // html string
  text: text, // plain text string
  content: content, // Content - operatins representation
  delta: delta, // Delta
  oldDelta: oldDelta, // Delta
  source: source // ('user', 'api', 'silent' , undefined)
}

• onSelectionChanged - selection is updated, also triggered for onBlur and onFocus, because the selection changed

{
  editor: editorInstance, // Quill
  range: range, // Range
  oldRange: oldRange, // Range
  source: source // ('user', 'api', 'silent' , undefined)
}

• onEditorChanged - text or selection is updated - independent of the source

{
  editor: editorInstance, // Quill
  event: 'text-change' // event type
  html: html, // html string
  text: text, // plain text string
  content: content, // Content - operatins representation
  delta: delta, // Delta
  oldDelta: oldDelta, // Delta
  source: source // ('user', 'api', 'silent' , undefined)
}

or

{
  editor: editorInstance, // Quill
  event: 'selection-change' // event type
  range: range, // Range
  oldRange: oldRange, // Range
  source: source // ('user', 'api', 'silent' , undefined)
}

• onFocus - editor is focused

{
  editor: editorInstance, // Quill
  source: source // ('user', 'api', 'silent' , undefined)
}

• onBlur - editor is blured

{
  editor: editorInstance, // Quill
  source: source // ('user', 'api', 'silent' , undefined)
}

QuillViewComponent, QuillViewHTMLComponent & How to present the editor content

In most cases a wysiwyg editor is used in backoffice to store the content to the database. On the other side this value should be used, to show the content to the enduser.

In most cases the html format is used, but it is not recommended by QuillJS, because it has the intention to be a solid, easy to maintain editor. Because of that it uses blots and object representations of the content and operation.

This content object is easy to store and to maintain, because there is no html syntax parsing necessary. So you even switching to another editor is very easy when you can work with that.

ngx-quill provides some helper components, to present quilljs content.

QuillViewComponent - Using QuillJS to render content

In general QuillJS recommends to use a QuillJS instance to present your content. Just create a quill editor without a toolbar and in readonly mode. With some simple css lines you can remove the default border around the content.

As a helper ngx-quill provides a component where you can pass many options of the quill-editor like modules, format, formats, customOptions, but renders only the content as readonly and without a toolbar. Import is the content input, where you can pass the editor content you want to present.

Config

• content - the content to be presented
• formats - array of allowed formats/groupings
• format - model format - default: html, values: html | object | text | json, sets the model value type - html = html string, object = quill operation object, json = quill operation json, text = plain text
• modules - configure/disable quill modules
• theme - bubble/snow, default is snow
• debug - set log level warn, error, log or false to deactivate logging, default: warn
• use custom-options for adding for example custom font sizes --> this overwrites this options globally !!!
• strict - default: true, sets editor in strict mode
• preserveWhitespace - default: false - possbility to use a pre-tag instead of a div-tag for the contenteditable area to preserve duplicated whitespaces | caution if used with syntax plugin Related issue

<quill-view [content]="content" format="text" theme="snow"></quill-view>

QuillViewHTMLComponent - Using angular [innerHTML]

Most of you will use the html format (even it is not recommended). To render custom html with angular you should use the [innerHTML] attribute.

But there are some pitfalls:

1. You need to have the quill css files loaded, when using classes and not inline styling (https://quilljs.com/guides/how-to-customize-quill/#class-vs-inline)
2. When using classes use a div-tag that has the innerHTML attribute and add the ql-editor class. Wrap your div in another div-tag with css classes ql-container and your theme, e.g. ql-snow.:

<div class="ql-container ql-snow" style="border-width: 0;">
  <div class="ql-editor" [innerHTML]="byPassedHTMLString">
  </div>
</div>

1. Angular has html sanitation, so it will strip unkown or not trusted parts of your HTML - just mark your html as trusted (DomSanitizer)

After that your content should look like what you expected.

If you store html in your database, checkout your backend code, sometimes backends are stripping unwanted tags as well ;).

As a helper ngx-quill provides a component where you can simply pass your html string and the component does everything for you to render it:

• add necessary css classes
• bypass html sanitation

<quill-view-html [content]="htmlstring" theme="snow"></quill-view-html>

Config

As inputs you can set the content and optional the theme (default is snow).

• content - html string to be presented
• theme - bubble/snow, default is snow

Security Hint

Angular templates provide some assurance against XSS in the form of client side sanitizing of all inputs https://angular.io/guide/security#xss.

Ngx-quill components provide the input paramter sanitize to sanitize html-strings passed as ngModel or formControl to the component.

It is deactivated per default to avoid stripping content or styling, which is not expected.

But it is recommended to activate this option, if you are working with html strings as model values.