@serenity-is/corelib / ConfirmDialogOptions
Additional options for confirm dialog
optional
autoDispose:boolean
Auto dispose dialog on close, default is true
MessageDialogOptions
.autoDispose
optional
autoOpen:boolean
True to auto open dialog
optional
backdrop:boolean
|"static"
Backdrop type, static to make it modal, e.g. can't be closed by clicking outside
optional
buttons:DialogButton
[]
List of buttons to show on the dialog
optional
cancelButton:boolean
True to also add a cancel button
optional
centered:boolean
Vertically center modal
optional
closeButton:boolean
Show close button, default is true
MessageDialogOptions
.closeButton
optional
closeOnEscape:boolean
Close dialog on escape key. Default is true for message dialogs.
MessageDialogOptions
.closeOnEscape
optional
dialogClass:string
CSS class to use for all dialog types. Is added to the top ui-dialog, panel or modal element
MessageDialogOptions
.dialogClass
optional
element:HTMLElement
|ArrayLike
<HTMLElement
> | (element
) =>void
Dialog content/body element, or callback that will populate the content element
optional
fade:boolean
Enable / disable animation. Default is false for message dialogs, true for other dialogs
optional
fullScreen:boolean
|"sm-down"
|"md-down"
|"lg-down"
|"xl-down"
|"xxl-down"
Sets one of modal-fullscreen{-...-down} classes. Only used for bootstrap modals
MessageDialogOptions
.fullScreen
optional
htmlEncode:boolean
HTML encode the message, default is true
MessageDialogOptions
.htmlEncode
optional
modal:boolean
Modal option for jQuery UI dialog compatibility only. Not to be confused with Bootstrap modal.
optional
onCancel: () =>void
Event handler for cancel button click
void
optional
onClose: (result
,e
?) =>void
Event handler that is called when dialog is closed
string
Event
void
optional
onNo: () =>void
Event handler for no button click
void
optional
onOpen: (e
?) =>void
Event handler that is called when dialog is opened
Event
void
optional
preferBSModal:boolean
Prefer Bootstrap modals to jQuery UI dialogs when both are available
MessageDialogOptions
.preferBSModal
optional
preferPanel:boolean
Prefer Panel even when Modal / jQuery UI is available
MessageDialogOptions
.preferPanel
optional
preWrap:boolean
Wrap the message in a <pre>
element, so that line endings are preserved, default is true
optional
providerOptions: (type
,opt
) =>any
Callback to get options specific to the dialog provider type
any
MessageDialogOptions
.providerOptions
optional
scrollable:boolean
Scrollable, sets content of the modal to scrollable, only for Bootstrap
MessageDialogOptions
.scrollable
optional
size:"sm"
|"md"
|"lg"
|"xl"
Size. Default is null for (500px) message dialogs, lg for normal dialogs
optional
title:string
Dialog title
optional
width:number
Only used for jQuery UI dialogs for backwards compatibility