Type alias TJSDialogOptions

TJSDialogOptions: {
    buttons?: Record<string, TJSDialogButtonData>;
    content?: TJSSvelteConfig | string;
    default?: string;
    draggable?: boolean;
    focusAuto?: boolean;
    focusFirst?: boolean;
    focusKeep?: boolean;
    focusTrap?: boolean;
    minimizable?: boolean;
    modal?: boolean;
    modalOptions?: TJSDialogModalOptions;
    notifyError?: boolean;
    onClose?: string | ((application) => any);
    rejectClose?: boolean;
    resizable?: boolean;
    resolveId?: boolean;
    title?: string;
    transition?: TJSDialogTransitionOptions;
    zIndex?: number | null;
}

Defines the common dialog configuration data.

Type declaration

  • Optional buttons?: Record<string, TJSDialogButtonData>

    Provides configuration of the dialog button bar.

  • Optional content?: TJSSvelteConfig | string

    A Svelte configuration object or HTML string content.

  • Optional default?: string

    The default button ID to focus initially.

  • Optional draggable?: boolean

    The dialog is draggable when true; default: true.

  • Optional focusAuto?: boolean

    When true auto-management of app focus is enabled; default: true.

  • Optional focusFirst?: boolean

    When true the first focusable element that isn't a button is focused; default: false.

  • Optional focusKeep?: boolean

    When focusAuto and focusKeep is true; keeps internal focus; default: false.

  • Optional focusTrap?: boolean

    When true focus trapping / wrapping is enabled keeping focus inside app; default: true.

  • Optional minimizable?: boolean

    When true the dialog is minimizable; default: true.

  • Optional modal?: boolean

    When true a modal dialog is displayed; default: false.

  • Optional modalOptions?: TJSDialogModalOptions

    Additional options for modal dialog display.

  • Optional notifyError?: boolean

    When true and an error is thrown in dialog callback functions post a UI error notification; default: false.

  • Optional onClose?: string | ((application) => any)

    Callback invoked when dialog is closed; no button option selected. When defined as a string any matching function by name exported from content Svelte component is invoked.

  • Optional rejectClose?: boolean

    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; default: false.

  • Optional resizable?: boolean

    When true the dialog is resizable; default: false.

  • Optional resolveId?: boolean

    When true and resolving any Promises and there are undefined results from any button callbacks the button ID is resolved; default: false.

  • Optional title?: string

    The dialog window title.

  • Optional transition?: TJSDialogTransitionOptions

    Transition options for the dialog.

  • Optional zIndex?: number | null

    A specific z-index for the dialog. Pass null for the dialog to act like other applications in regard bringing to top when activated.

Settings

Member Visibility

Theme