front/js-src/quill.d.ts

// import { Blot } from "../node_modules/parchment/dist/src/blot/abstract/blot";
interface Blot {}
interface Delta {
	ops: DeltaOperation[];
}

/**
 * A stricter type definition would be:
 *
 *   type DeltaOperation ({ insert: any } | { delete: number } | { retain: number }) & OptionalAttributes;
 *
 *  But this would break a lot of existing code as it would require manual discrimination of the union types.
 */
type DeltaOperation = { insert?: any, delete?: number, retain?: number } & OptionalAttributes;
type Sources = "api" | "user" | "silent";

interface Key {
	key: string | number;
	shortKey?: boolean;
}

interface StringMap {
	[key: string]: any;
}

interface OptionalAttributes {
	attributes?: StringMap;
}

type TextChangeHandler = (delta: Delta, oldContents: Delta, source: Sources) => any;
type SelectionChangeHandler = (range: RangeStatic, oldRange: RangeStatic, source: Sources) => any;
type EditorChangeHandler = ((name: "text-change", delta: Delta, oldContents: Delta, source: Sources) => any)
	| ((name: "selection-change", range: RangeStatic, oldRange: RangeStatic, source: Sources) => any);

interface KeyboardStatic {
	addBinding(key: Key, callback: (range: RangeStatic, context: any) => void): void;
	addBinding(key: Key, context: any, callback: (range: RangeStatic, context: any) => void): void;
	bindings: { [index: number]: any[] };
}

interface ClipboardStatic {
	convert(html?: string): Delta;
	addMatcher(selectorOrNodeType: string|number, callback: (node: any, delta: Delta) => Delta): void;
	dangerouslyPasteHTML(html: string, source?: Sources): void;
	dangerouslyPasteHTML(index: number, html: string, source?: Sources): void;
}

interface QuillOptionsStatic {
	debug?: string | boolean;
	modules?: StringMap;
	placeholder?: string;
	readOnly?: boolean;
	theme?: string;
	formats?: string[];
	bounds?: HTMLElement | string;
	scrollingContainer?: HTMLElement | string;
	strict?: boolean;
}

interface BoundsStatic {
	bottom: number;
	left: number;
	right: number;
	top: number;
	height: number;
	width: number;
}

declare interface RangeStatic {
	index: number;
	length: number;
}

declare class RangeStatic implements RangeStatic {
	constructor();
	index: number;
	length: number;
}

interface EventEmitter {
	on(eventName: "text-change", handler: TextChangeHandler): EventEmitter;
	on(eventName: "selection-change", handler: SelectionChangeHandler): EventEmitter;
	on(eventName: "editor-change", handler: EditorChangeHandler): EventEmitter;
	once(eventName: "text-change", handler: TextChangeHandler): EventEmitter;
	once(eventName: "selection-change", handler: SelectionChangeHandler): EventEmitter;
	once(eventName: "editor-change", handler: EditorChangeHandler): EventEmitter;
	off(eventName: "text-change", handler: TextChangeHandler): EventEmitter;
	off(eventName: "selection-change", handler: SelectionChangeHandler): EventEmitter;
	off(eventName: "editor-change", handler: EditorChangeHandler): EventEmitter;
}

declare class Quill {
	/**
	 * @private Internal API
	 */
	root: HTMLDivElement;
	container: HTMLElement; /// <- used by quill-mention
	clipboard: ClipboardStatic;
	scroll: Blot;
	keyboard: KeyboardStatic;
	constructor(container: string | Element, options?: QuillOptionsStatic);
	deleteText(index: number, length: number, source?: Sources): Delta;
	disable(): void;
	enable(enabled?: boolean): void;
	getContents(index?: number, length?: number): Delta;
	getLength(): number;
	getText(index?: number, length?: number): string;
	insertEmbed(index: number, type: string, value: any, source?: Sources): Delta;
	insertText(index: number, text: string, source?: Sources): Delta;
	insertText(index: number, text: string, format: string, value: any, source?: Sources): Delta;
	insertText(index: number, text: string, formats: StringMap, source?: Sources): Delta;
	/**
	 * @deprecated Remove in 2.0. Use clipboard.dangerouslyPasteHTML(index: number, html: string, source: Sources)
	 */
	pasteHTML(index: number, html: string, source?: Sources): string;
	/**
	 * @deprecated Remove in 2.0. Use clipboard.dangerouslyPasteHTML(html: string, source: Sources): void;
	 */
	pasteHTML(html: string, source?: Sources): string;
	setContents(delta: Delta, source?: Sources): Delta;
	setText(text: string, source?: Sources): Delta;
	update(source?: Sources): void;
	updateContents(delta: Delta, source?: Sources): Delta;
	
	format(name: string, value: any, source?: Sources): Delta;
	formatLine(index: number, length: number, source?: Sources): Delta;
	formatLine(index: number, length: number, format: string, value: any, source?: Sources): Delta;
	formatLine(index: number, length: number, formats: StringMap, source?: Sources): Delta;
	formatText(index: number, length: number, source?: Sources): Delta;
	formatText(index: number, length: number, format: string, value: any, source?: Sources): Delta;
	formatText(index: number, length: number, formats: StringMap, source?: Sources): Delta;
	formatText(range: RangeStatic, format: string, value: any, source?: Sources): Delta;
	formatText(range: RangeStatic, formats: StringMap, source?: Sources): Delta;
	getFormat(range?: RangeStatic): StringMap;
	getFormat(index: number, length?: number): StringMap;
	removeFormat(index: number, length: number, source?: Sources): Delta;
	
	blur(): void;
	focus(): void;
	getBounds(index: number, length?: number): BoundsStatic;
	getSelection(focus: true): RangeStatic;
	getSelection(focus?: false): RangeStatic | null;
	hasFocus(): boolean;
	setSelection(index: number, length: number, source?: Sources): void;
	setSelection(range: RangeStatic, source?: Sources): void;
	
	// static methods: debug, import, register, find
	static debug(level: string|boolean): void;
	static import(path: string): any;
	static register(path: string, def: any, suppressWarning?: boolean): void;
	static register(defs: StringMap, suppressWarning?: boolean): void;
	static find(domNode: Node, bubble?: boolean): Quill | any;
	
	addContainer(classNameOrDomNode: string|Node, refNode?: Node): any;
	getModule(name: string): any;
	
	// Blot interface is not exported on Parchment
	getIndex(blot: any): number;
	getLeaf(index: number): any;
	getLine(index: number): [any, number];
	getLines(index?: number, length?: number): any[];
	getLines(range: RangeStatic): any[];
	
	// EventEmitter methods
	on(eventName: "text-change", handler: TextChangeHandler): EventEmitter;
	on(eventName: "selection-change", handler: SelectionChangeHandler): EventEmitter;
	on(eventName: "editor-change", handler: EditorChangeHandler): EventEmitter;
	once(eventName: "text-change", handler: TextChangeHandler): EventEmitter;
	once(eventName: "selection-change", handler: SelectionChangeHandler): EventEmitter;
	once(eventName: "editor-change", handler: EditorChangeHandler): EventEmitter;
	off(eventName: "text-change", handler: TextChangeHandler): EventEmitter;
	off(eventName: "selection-change", handler: SelectionChangeHandler): EventEmitter;
	off(eventName: "editor-change", handler: EditorChangeHandler): EventEmitter;
	
	static sources: {
		API: 'api',
		SILENT: 'silent',
		USER: 'user',
	};
}