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