first commit
This commit is contained in:
218
public/assets/quill/core/quill.d.ts
vendored
Normal file
218
public/assets/quill/core/quill.d.ts
vendored
Normal file
@@ -0,0 +1,218 @@
|
||||
import * as Parchment from 'parchment';
|
||||
import type { Op } from 'quill-delta';
|
||||
import Delta from 'quill-delta';
|
||||
import type { BlockEmbed } from '../blots/block.js';
|
||||
import type Block from '../blots/block.js';
|
||||
import type Scroll from '../blots/scroll.js';
|
||||
import type Clipboard from '../modules/clipboard.js';
|
||||
import type History from '../modules/history.js';
|
||||
import type Keyboard from '../modules/keyboard.js';
|
||||
import type Uploader from '../modules/uploader.js';
|
||||
import Editor from './editor.js';
|
||||
import Emitter from './emitter.js';
|
||||
import type { EmitterSource } from './emitter.js';
|
||||
import type { DebugLevel } from './logger.js';
|
||||
import Module from './module.js';
|
||||
import Selection, { Range } from './selection.js';
|
||||
import type { Bounds } from './selection.js';
|
||||
import Composition from './composition.js';
|
||||
import Theme from './theme.js';
|
||||
import type { ThemeConstructor } from './theme.js';
|
||||
import type { Rect } from './utils/scrollRectIntoView.js';
|
||||
declare const globalRegistry: Parchment.Registry;
|
||||
/**
|
||||
* Options for initializing a Quill instance
|
||||
*/
|
||||
export interface QuillOptions {
|
||||
theme?: string;
|
||||
debug?: DebugLevel | boolean;
|
||||
registry?: Parchment.Registry;
|
||||
/**
|
||||
* Whether to disable the editing
|
||||
* @default false
|
||||
*/
|
||||
readOnly?: boolean;
|
||||
/**
|
||||
* Placeholder text to display when the editor is empty
|
||||
* @default ""
|
||||
*/
|
||||
placeholder?: string;
|
||||
bounds?: HTMLElement | string | null;
|
||||
modules?: Record<string, unknown>;
|
||||
/**
|
||||
* A list of formats that are recognized and can exist within the editor contents.
|
||||
* `null` means all formats are allowed.
|
||||
* @default null
|
||||
*/
|
||||
formats?: string[] | null;
|
||||
}
|
||||
/**
|
||||
* Similar to QuillOptions, but with all properties expanded to their default values,
|
||||
* and all selectors resolved to HTMLElements.
|
||||
*/
|
||||
export interface ExpandedQuillOptions extends Omit<QuillOptions, 'theme' | 'formats'> {
|
||||
theme: ThemeConstructor;
|
||||
registry: Parchment.Registry;
|
||||
container: HTMLElement;
|
||||
modules: Record<string, unknown>;
|
||||
bounds?: HTMLElement | null;
|
||||
readOnly: boolean;
|
||||
}
|
||||
declare class Quill {
|
||||
static DEFAULTS: {
|
||||
bounds: null;
|
||||
modules: {
|
||||
clipboard: boolean;
|
||||
keyboard: boolean;
|
||||
history: boolean;
|
||||
uploader: boolean;
|
||||
};
|
||||
placeholder: string;
|
||||
readOnly: false;
|
||||
registry: Parchment.Registry;
|
||||
theme: string;
|
||||
};
|
||||
static events: {
|
||||
readonly EDITOR_CHANGE: "editor-change";
|
||||
readonly SCROLL_BEFORE_UPDATE: "scroll-before-update";
|
||||
readonly SCROLL_BLOT_MOUNT: "scroll-blot-mount";
|
||||
readonly SCROLL_BLOT_UNMOUNT: "scroll-blot-unmount";
|
||||
readonly SCROLL_OPTIMIZE: "scroll-optimize";
|
||||
readonly SCROLL_UPDATE: "scroll-update";
|
||||
readonly SCROLL_EMBED_UPDATE: "scroll-embed-update";
|
||||
readonly SELECTION_CHANGE: "selection-change";
|
||||
readonly TEXT_CHANGE: "text-change";
|
||||
readonly COMPOSITION_BEFORE_START: "composition-before-start";
|
||||
readonly COMPOSITION_START: "composition-start";
|
||||
readonly COMPOSITION_BEFORE_END: "composition-before-end";
|
||||
readonly COMPOSITION_END: "composition-end";
|
||||
};
|
||||
static sources: {
|
||||
readonly API: "api";
|
||||
readonly SILENT: "silent";
|
||||
readonly USER: "user";
|
||||
};
|
||||
static version: string;
|
||||
static imports: Record<string, unknown>;
|
||||
static debug(limit: DebugLevel | boolean): void;
|
||||
static find(node: Node, bubble?: boolean): Parchment.Blot | Quill | null;
|
||||
static import(name: 'core/module'): typeof Module;
|
||||
static import(name: `themes/${string}`): typeof Theme;
|
||||
static import(name: 'parchment'): typeof Parchment;
|
||||
static import(name: 'delta'): typeof Delta;
|
||||
static import(name: string): unknown;
|
||||
static register(targets: Record<string, Parchment.RegistryDefinition | Record<string, unknown> | Theme | Module | Function>, overwrite?: boolean): void;
|
||||
static register(target: Parchment.RegistryDefinition, overwrite?: boolean): void;
|
||||
static register(path: string, target: any, overwrite?: boolean): void;
|
||||
container: HTMLElement;
|
||||
root: HTMLDivElement;
|
||||
scroll: Scroll;
|
||||
emitter: Emitter;
|
||||
protected allowReadOnlyEdits: boolean;
|
||||
editor: Editor;
|
||||
composition: Composition;
|
||||
selection: Selection;
|
||||
theme: Theme;
|
||||
keyboard: Keyboard;
|
||||
clipboard: Clipboard;
|
||||
history: History;
|
||||
uploader: Uploader;
|
||||
options: ExpandedQuillOptions;
|
||||
constructor(container: HTMLElement | string, options?: QuillOptions);
|
||||
addContainer(container: string, refNode?: Node | null): HTMLDivElement;
|
||||
addContainer(container: HTMLElement, refNode?: Node | null): HTMLElement;
|
||||
blur(): void;
|
||||
deleteText(range: Range, source?: EmitterSource): Delta;
|
||||
deleteText(index: number, length: number, source?: EmitterSource): Delta;
|
||||
disable(): void;
|
||||
editReadOnly<T>(modifier: () => T): T;
|
||||
enable(enabled?: boolean): void;
|
||||
focus(options?: {
|
||||
preventScroll?: boolean;
|
||||
}): void;
|
||||
format(name: string, value: unknown, source?: EmitterSource): Delta;
|
||||
formatLine(index: number, length: number, formats: Record<string, unknown>, source?: EmitterSource): Delta;
|
||||
formatLine(index: number, length: number, name: string, value?: unknown, source?: EmitterSource): Delta;
|
||||
formatText(range: Range, name: string, value: unknown, source?: EmitterSource): Delta;
|
||||
formatText(index: number, length: number, name: string, value: unknown, source?: EmitterSource): Delta;
|
||||
formatText(index: number, length: number, formats: Record<string, unknown>, source?: EmitterSource): Delta;
|
||||
getBounds(index: number | Range, length?: number): Bounds | null;
|
||||
getContents(index?: number, length?: number): Delta;
|
||||
getFormat(index?: number, length?: number): {
|
||||
[format: string]: unknown;
|
||||
};
|
||||
getFormat(range?: Range): {
|
||||
[format: string]: unknown;
|
||||
};
|
||||
getIndex(blot: Parchment.Blot): number;
|
||||
getLength(): number;
|
||||
getLeaf(index: number): [Parchment.LeafBlot | null, number];
|
||||
getLine(index: number): [Block | BlockEmbed | null, number];
|
||||
getLines(range: Range): (Block | BlockEmbed)[];
|
||||
getLines(index?: number, length?: number): (Block | BlockEmbed)[];
|
||||
getModule(name: string): unknown;
|
||||
getSelection(focus: true): Range;
|
||||
getSelection(focus?: boolean): Range | null;
|
||||
getSemanticHTML(range: Range): string;
|
||||
getSemanticHTML(index?: number, length?: number): string;
|
||||
getText(range?: Range): string;
|
||||
getText(index?: number, length?: number): string;
|
||||
hasFocus(): boolean;
|
||||
insertEmbed(index: number, embed: string, value: unknown, source?: EmitterSource): Delta;
|
||||
insertText(index: number, text: string, source?: EmitterSource): Delta;
|
||||
insertText(index: number, text: string, formats: Record<string, unknown>, source?: EmitterSource): Delta;
|
||||
insertText(index: number, text: string, name: string, value: unknown, source?: EmitterSource): Delta;
|
||||
isEnabled(): boolean;
|
||||
off(...args: Parameters<(typeof Emitter)['prototype']['off']>): Emitter;
|
||||
on(event: (typeof Emitter)['events']['TEXT_CHANGE'], handler: (delta: Delta, oldContent: Delta, source: EmitterSource) => void): Emitter;
|
||||
on(event: (typeof Emitter)['events']['SELECTION_CHANGE'], handler: (range: Range, oldRange: Range, source: EmitterSource) => void): Emitter;
|
||||
on(event: (typeof Emitter)['events']['EDITOR_CHANGE'], handler: (...args: [
|
||||
(typeof Emitter)['events']['TEXT_CHANGE'],
|
||||
Delta,
|
||||
Delta,
|
||||
EmitterSource
|
||||
] | [
|
||||
(typeof Emitter)['events']['SELECTION_CHANGE'],
|
||||
Range,
|
||||
Range,
|
||||
EmitterSource
|
||||
]) => void): Emitter;
|
||||
on(event: string, ...args: unknown[]): Emitter;
|
||||
once(...args: Parameters<(typeof Emitter)['prototype']['once']>): Emitter;
|
||||
removeFormat(index: number, length: number, source?: EmitterSource): Delta;
|
||||
scrollRectIntoView(rect: Rect): void;
|
||||
/**
|
||||
* @deprecated Use Quill#scrollSelectionIntoView() instead.
|
||||
*/
|
||||
scrollIntoView(): void;
|
||||
/**
|
||||
* Scroll the current selection into the visible area.
|
||||
* If the selection is already visible, no scrolling will occur.
|
||||
*/
|
||||
scrollSelectionIntoView(): void;
|
||||
setContents(delta: Delta | Op[], source?: EmitterSource): Delta;
|
||||
setSelection(range: Range | null, source?: EmitterSource): void;
|
||||
setSelection(index: number, source?: EmitterSource): void;
|
||||
setSelection(index: number, length?: number, source?: EmitterSource): void;
|
||||
setSelection(index: number, source?: EmitterSource): void;
|
||||
setText(text: string, source?: EmitterSource): Delta;
|
||||
update(source?: EmitterSource): void;
|
||||
updateContents(delta: Delta | Op[], source?: EmitterSource): Delta;
|
||||
}
|
||||
declare function expandConfig(containerOrSelector: HTMLElement | string, options: QuillOptions): ExpandedQuillOptions;
|
||||
type NormalizedIndexLength = [
|
||||
number,
|
||||
number,
|
||||
Record<string, unknown>,
|
||||
EmitterSource
|
||||
];
|
||||
declare function overload(index: number, source?: EmitterSource): NormalizedIndexLength;
|
||||
declare function overload(index: number, length: number, source?: EmitterSource): NormalizedIndexLength;
|
||||
declare function overload(index: number, length: number, format: string, value: unknown, source?: EmitterSource): NormalizedIndexLength;
|
||||
declare function overload(index: number, length: number, format: Record<string, unknown>, source?: EmitterSource): NormalizedIndexLength;
|
||||
declare function overload(range: Range, source?: EmitterSource): NormalizedIndexLength;
|
||||
declare function overload(range: Range, format: string, value: unknown, source?: EmitterSource): NormalizedIndexLength;
|
||||
declare function overload(range: Range, format: Record<string, unknown>, source?: EmitterSource): NormalizedIndexLength;
|
||||
export type { Bounds, DebugLevel, EmitterSource };
|
||||
export { Parchment, Range };
|
||||
export { globalRegistry, expandConfig, overload, Quill as default };
|
||||
Reference in New Issue
Block a user