Type Alias OptionsData
alwaysOnTop?: boolean;
buttons?: { [key: string]: TJSDialog.ButtonData };
content?: Embed | string;
default?: string;
draggable?: boolean;
focusAuto?: boolean;
focusFirst?: boolean;
focusKeep?: boolean;
focusTrap?: boolean;
minimizable?: boolean;
modal?: boolean;
modalOptions?: OptionsModal;
notifyError?: boolean;
onClose?: string | ((data?: { application: TJSDialog }) => any);
rejectClose?: boolean;
resizable?: boolean;
resolveId?: boolean;
title?: string;
transition?: OptionsTransition;
zIndex?: number | null;
}
Properties
OptionalalwaysOnTop
The dialog is always on top when true.
Optionalbuttons
Provides configuration of the dialog button bar.
Optionalcontent
A Svelte configuration object or HTML string content.
Optionaldefault
The default button ID to focus initially.
Optionaldraggable
The dialog is draggable when true.
OptionalfocusAuto
When true, auto-management of app focus is enabled.
OptionalfocusFirst
When true, the first focusable element that isn't a button is focused.
OptionalfocusKeep
When focusAuto and focusKeep is true; keeps internal focus.
OptionalfocusTrap
When true, focus trapping / wrapping is enabled keeping focus inside the app.
Optionalminimizable
When true, the dialog is minimizable.
Optionalmodal
When true, a modal dialog is displayed.
OptionalmodalOptions
Additional options for modal dialog display.
OptionalnotifyError
When true and an error is thrown in dialog callback functions post a UI error notification.
OptionalonClose
Callback invoked when the dialog is closed; no button option selected. When defined as a string, any matching function by name exported from the content Svelte component is invoked.
OptionalrejectClose
When true and a Promise has been created by TJSDialog.wait and the Promise is not in the process of
being resolved or rejected on close of the dialog any onClose function is invoked and any result that is
undefined will cause the Promise to then be rejected.
Optionalresizable
When true, the dialog is resizable.
OptionalresolveId
When true and resolving any Promises and there are undefined results from any of the button callbacks, the button ID is resolved.
Optionaltitle
The dialog window title.
Optionaltransition
Transition options for the dialog.
OptionalzIndex
A specific z-index for the dialog.
Defines the common dialog configuration data.