@types/quill

What is @types/quill?

@types/quill provides TypeScript definitions for the Quill rich text editor, allowing developers to use Quill in TypeScript projects with type safety and IntelliSense support.

What are @types/quill's main functionalities?

Basic Editor Initialization

Initializes a basic Quill editor with the 'snow' theme. This is the most fundamental use case for setting up a Quill editor.

const quill = new Quill('#editor', { theme: 'snow' });

Custom Toolbar

Sets up a Quill editor with a custom toolbar configuration, allowing for specific formatting options like bold, italic, and lists.

const toolbarOptions = [['bold', 'italic'], [{ 'list': 'ordered'}, { 'list': 'bullet' }]]; const quill = new Quill('#editor', { modules: { toolbar: toolbarOptions }, theme: 'snow' });

Event Handling

Adds an event listener to the Quill editor to handle text changes, useful for reacting to user input in real-time.

quill.on('text-change', function(delta, oldDelta, source) { console.log('Text change detected!'); });

Content Retrieval

Retrieves the current content of the Quill editor in Delta format, which can be used for saving or processing the editor's content.

const content = quill.getContents(); console.log(content);

Other packages similar to @types/quill

@types/tinymce

Provides TypeScript definitions for TinyMCE, another popular rich text editor. Similar to @types/quill, it offers type safety and IntelliSense for TinyMCE in TypeScript projects.

@types/ckeditor__ckeditor5-core

Offers TypeScript definitions for CKEditor 5, a modern rich text editor. It provides similar functionalities to Quill but with a different set of features and plugins.

@types/medium-editor

TypeScript definitions for MediumEditor, a simple inline editor. It is less feature-rich compared to Quill but offers a lightweight alternative for basic editing needs.

README

Installation

npm install --save @types/quill

Summary

This package contains type definitions for Quill (https://github.com/quilljs/quill/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/quill.

Additional Details

• Last updated: Mon, 12 Dec 2022 19:03:17 GMT
• Dependencies: @types/parchment, @types/quill-delta
• Global values: none

Credits

These definitions were written by Sumit, Guillaume, James Garbutt, Aniello Falcone, Mohammad Hossein Amri, Marco Mantovani, and Ameer Hamoodi.