Class Quill

Hierarchy

Quill

Implements

EventEmitter

Constructors

constructor

new Quill(container: string | Element, options?: QuillOptionsStatic): Quill

Parameters
- container: string | Element
- Optional options: QuillOptionsStatic
Returns Quill

Properties

clipboard

clipboard: ClipboardStatic

keyboard

keyboard: KeyboardStatic

Private root

root: HTMLDivElement

scroll

scroll: Blot

Methods

addContainer

addContainer(classNameOrDomNode: string | Node, refNode?: Node): any

Parameters
- classNameOrDomNode: string | Node
- Optional refNode: Node
Returns any

blur

blur(): void

Returns void

deleteText

deleteText(index: number, length: number, source?: Sources): DeltaStatic

Parameters
- index: number
- length: number
- Optional source: Sources
Returns DeltaStatic

disable

disable(): void

Returns void

enable

enable(enabled?: boolean): void

Parameters
- Optional enabled: boolean
Returns void

focus

focus(): void

Returns void

format

format(name: string, value: any, source?: Sources): DeltaStatic

Parameters
- name: string
- value: any
- Optional source: Sources
Returns DeltaStatic

formatLine

formatLine(index: number, length: number, source?: Sources): DeltaStatic
formatLine(index: number, length: number, format: string, value: any, source?: Sources): DeltaStatic
formatLine(index: number, length: number, formats: StringMap, source?: Sources): DeltaStatic

Parameters
- index: number
- length: number
- Optional source: Sources
Returns DeltaStatic
Parameters
- index: number
- length: number
- format: string
- value: any
- Optional source: Sources
Returns DeltaStatic
Parameters
- index: number
- length: number
- formats: StringMap
- Optional source: Sources
Returns DeltaStatic

formatText

formatText(index: number, length: number, source?: Sources): DeltaStatic
formatText(index: number, length: number, format: string, value: any, source?: Sources): DeltaStatic
formatText(index: number, length: number, formats: StringMap, source?: Sources): DeltaStatic
formatText(range: RangeStatic, format: string, value: any, source?: Sources): DeltaStatic
formatText(range: RangeStatic, formats: StringMap, source?: Sources): DeltaStatic

Parameters
- index: number
- length: number
- Optional source: Sources
Returns DeltaStatic
Parameters
- index: number
- length: number
- format: string
- value: any
- Optional source: Sources
Returns DeltaStatic
Parameters
- index: number
- length: number
- formats: StringMap
- Optional source: Sources
Returns DeltaStatic
Parameters
- range: RangeStatic
- format: string
- value: any
- Optional source: Sources
Returns DeltaStatic
Parameters
- range: RangeStatic
- formats: StringMap
- Optional source: Sources
Returns DeltaStatic

getBounds

getBounds(index: number, length?: number): BoundsStatic

Parameters
- index: number
- Optional length: number
Returns BoundsStatic

getContents

getContents(index?: number, length?: number): DeltaStatic

Parameters
- Optional index: number
- Optional length: number
Returns DeltaStatic

getFormat

getFormat(range?: RangeStatic): StringMap
getFormat(index: number, length?: number): StringMap

Parameters
- Optional range: RangeStatic
Returns StringMap
Parameters
- index: number
- Optional length: number
Returns StringMap

getIndex

getIndex(blot: any): number

Parameters
- blot: any
Returns number

getLeaf

getLeaf(index: number): any

Parameters
- index: number
Returns any

getLength

getLength(): number

Returns number

getLine

getLine(index: number): [any, number]

Parameters
- index: number
Returns [any, number]

getLines

getLines(index?: number, length?: number): any[]
getLines(range: RangeStatic): any[]

Parameters
- Optional index: number
- Optional length: number
Returns any[]
Parameters
- range: RangeStatic
Returns any[]

getModule

getModule(name: string): any

Parameters
- name: string
Returns any

getSelection

getSelection(focus: true): RangeStatic
getSelection(focus?: false): null | RangeStatic

Parameters
- focus: true
Returns RangeStatic
Parameters
- Optional focus: false
Returns null | RangeStatic

getText

getText(index?: number, length?: number): string

Parameters
- Optional index: number
- Optional length: number
Returns string

hasFocus

hasFocus(): boolean

Returns boolean

insertEmbed

insertEmbed(index: number, type: string, value: any, source?: Sources): DeltaStatic

Parameters
- index: number
- type: string
- value: any
- Optional source: Sources
Returns DeltaStatic

insertText

insertText(index: number, text: string, source?: Sources): DeltaStatic
insertText(index: number, text: string, format: string, value: any, source?: Sources): DeltaStatic
insertText(index: number, text: string, formats: StringMap, source?: Sources): DeltaStatic

Parameters
- index: number
- text: string
- Optional source: Sources
Returns DeltaStatic
Parameters
- index: number
- text: string
- format: string
- value: any
- Optional source: Sources
Returns DeltaStatic
Parameters
- index: number
- text: string
- formats: StringMap
- Optional source: Sources
Returns DeltaStatic

off

off(eventName: "text-change", handler: TextChangeHandler): EventEmitter
off(eventName: "selection-change", handler: SelectionChangeHandler): EventEmitter
off(eventName: "editor-change", handler: EditorChangeHandler): EventEmitter

Implementation of EventEmitter.off
Parameters
- eventName: "text-change"
- handler: TextChangeHandler
Returns EventEmitter
Implementation of EventEmitter.off
Parameters
- eventName: "selection-change"
- handler: SelectionChangeHandler
Returns EventEmitter
Implementation of EventEmitter.off
Parameters
- eventName: "editor-change"
- handler: EditorChangeHandler
Returns EventEmitter

on

on(eventName: "text-change", handler: TextChangeHandler): EventEmitter
on(eventName: "selection-change", handler: SelectionChangeHandler): EventEmitter
on(eventName: "editor-change", handler: EditorChangeHandler): EventEmitter

Implementation of EventEmitter.on
Parameters
- eventName: "text-change"
- handler: TextChangeHandler
Returns EventEmitter
Implementation of EventEmitter.on
Parameters
- eventName: "selection-change"
- handler: SelectionChangeHandler
Returns EventEmitter
Implementation of EventEmitter.on
Parameters
- eventName: "editor-change"
- handler: EditorChangeHandler
Returns EventEmitter

once

once(eventName: "text-change", handler: TextChangeHandler): EventEmitter
once(eventName: "selection-change", handler: SelectionChangeHandler): EventEmitter
once(eventName: "editor-change", handler: EditorChangeHandler): EventEmitter

Implementation of EventEmitter.once
Parameters
- eventName: "text-change"
- handler: TextChangeHandler
Returns EventEmitter
Implementation of EventEmitter.once
Parameters
- eventName: "selection-change"
- handler: SelectionChangeHandler
Returns EventEmitter
Implementation of EventEmitter.once
Parameters
- eventName: "editor-change"
- handler: EditorChangeHandler
Returns EventEmitter

pasteHTML

pasteHTML(index: number, html: string, source?: Sources): string
pasteHTML(html: string, source?: Sources): string

deprecated
Remove in 2.0. Use clipboard.dangerouslyPasteHTML(index: number, html: string, source: Sources)

Parameters
- index: number
- html: string
- Optional source: Sources
Returns string
deprecated
Remove in 2.0. Use clipboard.dangerouslyPasteHTML(html: string, source: Sources): void;

Parameters
- html: string
- Optional source: Sources
Returns string

removeFormat

removeFormat(index: number, length: number, source?: Sources): DeltaStatic

Parameters
- index: number
- length: number
- Optional source: Sources
Returns DeltaStatic

setContents

setContents(delta: DeltaStatic, source?: Sources): DeltaStatic

Parameters
- delta: DeltaStatic
- Optional source: Sources
Returns DeltaStatic

setSelection

setSelection(index: number, length: number, source?: Sources): void
setSelection(range: RangeStatic, source?: Sources): void

Parameters
- index: number
- length: number
- Optional source: Sources
Returns void
Parameters
- range: RangeStatic
- Optional source: Sources
Returns void

setText

setText(text: string, source?: Sources): DeltaStatic

Parameters
- text: string
- Optional source: Sources
Returns DeltaStatic

update

update(source?: Sources): void

Parameters
- Optional source: Sources
Returns void

updateContents

updateContents(delta: DeltaStatic, source?: Sources): DeltaStatic

Parameters
- delta: DeltaStatic
- Optional source: Sources
Returns DeltaStatic

Static debug

debug(level: string | boolean): void

Parameters
- level: string | boolean
Returns void

Static find

find(domNode: Node, bubble?: boolean): any

Parameters
- domNode: Node
- Optional bubble: boolean
Returns any

Static import

import(path: string): any

Parameters
- path: string
Returns any

Static register

register(path: string, def: any, suppressWarning?: boolean): void
register(defs: StringMap, suppressWarning?: boolean): void

Parameters
- path: string
- def: any
- Optional suppressWarning: boolean
Returns void
Parameters
- defs: StringMap
- Optional suppressWarning: boolean
Returns void

Generated using TypeDoc