Interface ShowOptions

Defines the allowed options to the show method.

interface ShowOptions {
    autoCommit?: boolean;
    container?: string | Element;
    data?: Record<string, any>;
    msg?: string;
    onCancel?: CancelFunction;
    onClose?: CloseFunction;
    onMaybeClose?: MaybeCloseFunction;
    onOK?: CommitFunction;
    onOpen?: OpenFunction;
    position?: string;
    reposition?: boolean;
    title?: string;
}

Properties

autoCommit? container? data? msg? onCancel? onClose? onMaybeClose? onOK? onOpen? position? reposition? title?

Properties

Optional autoCommit

autoCommit?: boolean

If true (which is the default), an enter keypress on an input field, or a ctrl+enter keypress on a textarea, will close the dialog as if the user had pressed OK.

Optional container

container?: string | Element

parent element for dialog elements. Defaults to document body.

Optional data

data?: Record<string, any>

Data to bind to the dialog.

Optional msg

msg?: string

Optional message to show in the dialog.

Optional onCancel

onCancel?: CancelFunction

Handler for when the user presses Cancel.

Optional onClose

onClose?: CloseFunction

Callback invoked after the dialog has been closed.

Optional onMaybeClose

onMaybeClose?: MaybeCloseFunction

Interceptor that can be used to prevent dialog from being closed (by returning false).

Optional onOK

onOK?: CommitFunction

Handler for when the user presses OK

Optional onOpen

onOpen?: OpenFunction

Callback invoked after the dialog has been displayed.

Optional position

position?: string

"top" or "bottom" - where to show the dialog in the viewport. Defaults to "top".

Optional reposition

reposition?: boolean

If true, reposition the dialogs when a scroll or resize event has occurred.

Optional title

title?: string

Optional title for the dialog.

Settings

Member Visibility

Theme

On This Page

autoCommitcontainerdatamsgonCancelonCloseonMaybeCloseonOKonOpenpositionrepositiontitle