@serenity-is/corelib / DialogOptions
Interface: DialogOptions
Options that apply to all dialog types
Extended by
Properties
autoDispose?
optionalautoDispose:boolean
Auto dispose dialog on close, default is true
Defined in
autoOpen?
optionalautoOpen:boolean
True to auto open dialog
Defined in
backdrop?
optionalbackdrop:boolean|"static"
Backdrop type, static to make it modal, e.g. can't be closed by clicking outside
Defined in
buttons?
optionalbuttons:DialogButton[]
List of buttons to show on the dialog
Defined in
centered?
optionalcentered:boolean
Vertically center modal
Defined in
closeButton?
optionalcloseButton:boolean
Show close button, default is true
Defined in
closeOnEscape?
optionalcloseOnEscape:boolean
Close dialog on escape key. Default is true for message dialogs.
Defined in
dialogClass?
optionaldialogClass:string
CSS class to use for all dialog types. Is added to the top ui-dialog, panel or modal element
Defined in
element?
optionalelement:HTMLElement|ArrayLike<HTMLElement> | (element) =>void
Dialog content/body element, or callback that will populate the content element
Defined in
fade?
optionalfade:boolean
Enable / disable animation. Default is false for message dialogs, true for other dialogs
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
Defined in
modal?
optionalmodal:boolean
Modal option for jQuery UI dialog compatibility only. Not to be confused with Bootstrap modal.
Defined in
onClose()?
optionalonClose: (result,e?) =>void
Event handler that is called when dialog is closed
Parameters
result
string
e?
Event
Returns
void
Defined in
onOpen()?
optionalonOpen: (e?) =>void
Event handler that is called when dialog is opened
Parameters
e?
Event
Returns
void
Defined in
preferBSModal?
optionalpreferBSModal:boolean
Prefer Bootstrap modals to jQuery UI dialogs when both are available
Defined in
preferPanel?
optionalpreferPanel:boolean
Prefer Panel even when Modal / jQuery UI is available
Defined in
providerOptions()?
optionalproviderOptions: (type,opt) =>any
Callback to get options specific to the dialog provider type
Parameters
type
opt
Returns
any
Defined in
scrollable?
optionalscrollable:boolean
Scrollable, sets content of the modal to scrollable, only for Bootstrap
Defined in
size?
optionalsize:"sm"|"md"|"lg"|"xl"
Size. Default is null for (500px) message dialogs, lg for normal dialogs
Defined in
title?
optionaltitle:string
Dialog title
Defined in
width?
optionalwidth:number
Only used for jQuery UI dialogs for backwards compatibility