Dialog API · Text Diagram

Signatures and descriptions are extracted from public exports and JSDoc. Chinese explanations are checked against current source. See Embed in Vue for the component integration.

Standalone workbench

openTextDiagramDialog

@quirekit/text-diagram-editor

@param options - One independently scoped authoring request. @returns Idempotent cancellation handle.

function openTextDiagramDialog(options: TextDiagramDialogOptions): TextDiagramDialogHandle

TextDiagramDialogOptions

@quirekit/text-diagram-editor

One independent host-owned text diagram task.

export interface TextDiagramDialogOptions {
    readonly request: TextDiagramEditRequest;
    readonly ownerDocument: Document;
    readonly locale?: string;
    readonly theme?: QuireKitTheme;
    readonly signal?: AbortSignal;
}

Member	Description
`request`	Initial source and final atomic commit owner.
`ownerDocument`	Browser document owning the overlay.
`locale`	Host interface language.
`theme`	Host theme, independent of persisted preview appearance.
`signal`	Host lifetime.

TextDiagramDialogHandle

@quirekit/text-diagram-editor

Safe before or after lazy dialog mounting.

export interface TextDiagramDialogHandle {
    close(): void;
}

Member	Description
`close`	Cancels and releases without saving.

textDiagramMessages

@quirekit/text-diagram-editor

@param locale - Host language. @returns All feature-owned interface labels.

function textDiagramMessages(locale?: string): { title: string; language: string; template: string; apply: string; source: string; preview: string; name: string; cancel: string; save: string; loading: string; empty: string; retry: string; svg: string; png: string; local: string; error: string; conflict: string; readonly: string; missing: string; composing: string; find: string; sourceHint: string; sourceLimit: string; }