extension.md

Extension

debug

Static method enabling logging messages at a given level: 'error', 'warn', 'log', or 'info'. Passing true is equivalent to passing 'log'. Passing false disables all messages.

Methods

DevExpress.Quill.debug(level: String | Boolean)

Examples

DevExpress.Quill.debug('info');

import

Static method returning Quill library, format, module, or theme. In general the path should map exactly to Quill source code directory structure. Unless stated otherwise, modification of returned entities may break required Quill functionality and is strongly discouraged.

Methods

DevExpress.Quill.import(path): any

Examples

var Parchment = DevExpress.Quill.import('parchment');
var Delta = DevExpress.Quill.import('delta');

var Clipboard = DevExpress.Quill.import('modules/Clipboard');
var Link = DevExpress.Quill.import('formats/link');
// Similar to ES6 syntax `import Link from 'quill/formats/link';`

register

Registers a module, theme, or format(s), making them available to be added to an editor. Can later be retrieved with DevExpress.Quill.import. Use the path prefix of 'formats/', 'modules/', or 'themes/' for registering formats, modules or themes, respectively. For formats specifically there is a shortand to just pass in the format directly and the path will be autogenerated. Will overwrite existing definitions with the same path.

Methods

DevExpress.Quill.register(format: Attributor | BlotDefinintion, supressWarning: Boolean = false)
DevExpress.Quill.register(path: String, def: any, supressWarning: Boolean = false)
DevExpress.Quill.register(defs: { [String]: any }, supressWarning: Boolean = false)

Examples

var Module = DevExpress.Quill.import('core/module');

class CustomModule extends Module {}

DevExpress.Quill.register('modules/custom-module', CustomModule);

DevExpress.Quill.register({
  'formats/custom-format': CustomFormat,
  'modules/custom-module-a': CustomModuleA,
  'modules/custom-module-b': CustomModuleB,
});

DevExpress.Quill.register(CustomFormat);
// You cannot do DevExpress.Quill.register(CustomModuleA); as CustomModuleA is not a format

addContainer

Adds and returns a container element inside the Quill container, sibling to the editor itself. By convention, Quill modules should have a class name prefixed with ql-. Optionally include a refNode where container should be inserted before.

Methods

addContainer(className: String, refNode?: Node): Element
addContainer(domNode: Node, refNode?: Node): Element

Examples

var container = quill.addContainer('ql-custom');

getModule

Retrieves a module that has been added to the editor.

Methods

getModule(name: String): any

Examples

var toolbar = quill.getModule('toolbar');

disable

Shorthand for enable(false).

enable

Set ability for user to edit, via input devices like the mouse or keyboard. Does not affect capabilities of API calls.

Methods

enable(value: Boolean = true)

Examples

quill.enable();
quill.enable(false);   // Disables user input