Previous Page Next Page

@serenity-is/corelib / MessageDialogOptions

Interface: MessageDialogOptions

Defined in: src/base/dialogs.tsx:900

Options that apply to all message dialog types

Extends

Extended by

Properties

autoDispose?

optional autoDispose: boolean

Defined in: src/base/dialogs.tsx:36

Auto dispose dialog on close, default is true

Inherited from

DialogOptions.autoDispose

autoOpen?

optional autoOpen: boolean

Defined in: src/base/dialogs.tsx:38

True to auto open dialog

Inherited from

DialogOptions.autoOpen

backdrop?

optional backdrop: boolean | "static"

Defined in: src/base/dialogs.tsx:40

Backdrop type, static to make it modal, e.g. can't be closed by clicking outside

Inherited from

DialogOptions.backdrop

buttons?

optional buttons: DialogButton[]

Defined in: src/base/dialogs.tsx:42

List of buttons to show on the dialog

Inherited from

DialogOptions.buttons

centered?

optional centered: boolean

Defined in: src/base/dialogs.tsx:44

Vertically center modal

Inherited from

DialogOptions.centered

closeButton?

optional closeButton: boolean

Defined in: src/base/dialogs.tsx:46

Show close button, default is true

Inherited from

DialogOptions.closeButton

closeOnEscape?

optional closeOnEscape: boolean

Defined in: src/base/dialogs.tsx:48

Close dialog on escape key. Default is true for message dialogs.

Inherited from

DialogOptions.closeOnEscape

dialogClass?

optional dialogClass: string

Defined in: src/base/dialogs.tsx:50

CSS class to use for all dialog types. Is added to the top ui-dialog, panel or modal element

Inherited from

DialogOptions.dialogClass

element?

optional element: HTMLElement | ArrayLike<HTMLElement> | (element) => void

Defined in: src/base/dialogs.tsx:52

Dialog content/body element, or callback that will populate the content element

Inherited from

DialogOptions.element

fade?

optional fade: boolean

Defined in: src/base/dialogs.tsx:54

Enable / disable animation. Default is false for message dialogs, true for other dialogs

Inherited from

DialogOptions.fade

fullScreen?

optional fullScreen: boolean | "sm-down" | "md-down" | "lg-down" | "xl-down" | "xxl-down"

Defined in: src/base/dialogs.tsx:56

Sets one of modal-fullscreen{-...-down} classes. Only used for bootstrap modals

Inherited from

DialogOptions.fullScreen

htmlEncode?

optional htmlEncode: boolean

Defined in: src/base/dialogs.tsx:902

Deprecated

HTML encode the message, default is true

optional modal: boolean

Defined in: src/base/dialogs.tsx:58

Modal option for jQuery UI dialog compatibility only. Not to be confused with Bootstrap modal.

Inherited from

DialogOptions.modal

onClose()?

optional onClose: (result, e?) => void

Defined in: src/base/dialogs.tsx:62

Event handler that is called when dialog is closed

Parameters

result

string

e?

Event

Returns

void

Inherited from

DialogOptions.onClose

onOpen()?

optional onOpen: (e?) => void

Defined in: src/base/dialogs.tsx:60

Event handler that is called when dialog is opened

Parameters

e?

Event

Returns

void

Inherited from

DialogOptions.onOpen

preferBSModal?

optional preferBSModal: boolean

Defined in: src/base/dialogs.tsx:64

Prefer Bootstrap modals to jQuery UI dialogs when both are available

Inherited from

DialogOptions.preferBSModal

preferPanel?

optional preferPanel: boolean

Defined in: src/base/dialogs.tsx:66

Prefer Panel even when Modal / jQuery UI is available

Inherited from

DialogOptions.preferPanel

preWrap?

optional preWrap: boolean

Defined in: src/base/dialogs.tsx:904

Wrap the message in a <pre> element, so that line endings are preserved, default is true

providerOptions()?

optional providerOptions: (type, opt) => any

Defined in: src/base/dialogs.tsx:68

Callback to get options specific to the dialog provider type

Parameters

type

DialogProviderType

opt

DialogOptions

Returns

any

Inherited from

DialogOptions.providerOptions

scrollable?

optional scrollable: boolean

Defined in: src/base/dialogs.tsx:70

Scrollable, sets content of the modal to scrollable, only for Bootstrap

Inherited from

DialogOptions.scrollable

size?

optional size: "sm" | "md" | "lg" | "xl"

Defined in: src/base/dialogs.tsx:72

Size. Default is null for (500px) message dialogs, lg for normal dialogs

Inherited from

DialogOptions.size

title?

optional title: string

Defined in: src/base/dialogs.tsx:74

Dialog title

Inherited from

DialogOptions.title

width?

optional width: number

Defined in: src/base/dialogs.tsx:76

Only used for jQuery UI dialogs for backwards compatibility

Inherited from

DialogOptions.width