@serenity-is/corelib / CommonDialogOptions
Interface: CommonDialogOptions
Options that apply to all message dialog types
Hierarchy
CommonDialogOptions
Table of contents
Properties
Properties
bootstrap
• Optional bootstrap: boolean
True to use Bootstrap dialogs even when jQuery UI present, default is based on `Q.Config.bootstrapMessages
Defined in
buttons
• Optional buttons: DialogButton[]
List of buttons to show on the dialog
Defined in
dialogClass
• Optional dialogClass: string
Dialog css class. Default is based on the message dialog type
Defined in
htmlEncode
• Optional htmlEncode: boolean
HTML encode the message, default is true
Defined in
modalClass
• Optional modalClass: string
Class to use for the modal element for Bootstrap dialogs
Defined in
onClose
• Optional onClose: (result: string) => void
Type declaration
▸ (result): void
Event handler that is called when dialog is closed
Parameters
| Name | Type |
|---|---|
result |
string |
Returns
void
Defined in
onOpen
• Optional onOpen: () => void
Type declaration
▸ (): void
Event handler that is called when dialog is opened
Returns
void
Defined in
preWrap
• Optional preWrap: boolean
Wrap the message in a <pre> element, so that line endings are preserved, default is true
Defined in
result
• Optional result: string
The result code of the button used to close the dialog is returned via this variable in the options object
Defined in
title
• Optional title: string
Dialog title