@serenity-is/corelib / ConfirmOptions
Interface: ConfirmOptions
Additional options for confirm dialog
Hierarchy
-
↳
ConfirmOptions
Table of contents
Properties
- bootstrap
- buttons
- cancelButton
- dialogClass
- htmlEncode
- modalClass
- noButton
- onCancel
- onClose
- onNo
- onOpen
- preWrap
- result
- title
- yesButton
- yesButtonClass
Properties
bootstrap
• Optional bootstrap: boolean
True to use Bootstrap dialogs even when jQuery UI present, default is based on `Q.Config.bootstrapMessages
Inherited from
Defined in
buttons
• Optional buttons: DialogButton[]
List of buttons to show on the dialog
Inherited from
Defined in
cancelButton
• Optional cancelButton: string | boolean
Title of the CANCEL button, or false to hide the Cancel button. Default is value of local text: "Dialogs.NoButton"
Defined in
dialogClass
• Optional dialogClass: string
Dialog css class. Default is based on the message dialog type
Inherited from
CommonDialogOptions.dialogClass
Defined in
htmlEncode
• Optional htmlEncode: boolean
HTML encode the message, default is true
Inherited from
CommonDialogOptions.htmlEncode
Defined in
modalClass
• Optional modalClass: string
Class to use for the modal element for Bootstrap dialogs
Inherited from
CommonDialogOptions.modalClass
Defined in
noButton
• Optional noButton: string | boolean
Title of the NO button, or false to hide the No button. Default is value of local text: "Dialogs.NoButton"
Defined in
onCancel
• Optional onCancel: () => void
Type declaration
▸ (): void
Event handler for cancel button click
Returns
void
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
Inherited from
Defined in
onNo
• Optional onNo: () => void
Type declaration
▸ (): void
Event handler for no button click
Returns
void
Defined in
onOpen
• Optional onOpen: () => void
Type declaration
▸ (): void
Event handler that is called when dialog is opened
Returns
void
Inherited from
Defined in
preWrap
• Optional preWrap: boolean
Wrap the message in a <pre> element, so that line endings are preserved, default is true
Inherited from
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
Inherited from
Defined in
title
• Optional title: string
Dialog title
Inherited from
Defined in
yesButton
• Optional yesButton: string | boolean
Title of the Yes button, or false to hide the Yes button. Default is value of local text: "Dialogs.YesButton"
Defined in
yesButtonClass
• Optional yesButtonClass: string
CSS class for the Yes button.