packages/website/content/docs/modules.mdx
Modules allow Quill's behavior and functionality to be customized. Several officially supported modules are available to pick and choose from, some with additional configuration options and APIs. Refer to their respective documentation pages for more details.
To enable a module, simply include it in Quill's configuration.
const quill = new Quill('#editor', {
modules: {
history: { // Enable with custom configurations
delay: 2500,
userOnly: true
},
syntax: true // Enable with default configuration
}
});
The Clipboard, Keyboard, and History modules are required by Quill and do not need to be included explictly, but may be configured like any other module.
Modules may also be extended and re-registered, replacing the original module. Even required modules may be re-registered and replaced.
const Clipboard = Quill.import('modules/clipboard');
const Delta = Quill.import('delta');
class PlainClipboard extends Clipboard {
convert(html = null) {
if (typeof html === 'string') {
this.container.innerHTML = html;
}
let text = this.container.innerText;
this.container.innerHTML = '';
return new Delta().insert(text);
}
}
Quill.register('modules/clipboard', PlainClipboard, true);
// Will be created with instance of PlainClipboard
const quill = new Quill('#editor');