@serenity-is/corelib / ConfirmDialogOptions

Interface: ConfirmDialogOptions

Additional options for confirm dialog

Hierarchy

• MessageDialogOptions

  ↳ ConfirmDialogOptions

Table of contents

Properties

• autoDispose
• autoOpen
• backdrop
• buttons
• cancelButton
• centered
• closeButton
• closeOnEscape
• dialogClass
• element
• fade
• fullScreen
• htmlEncode
• modal
• onCancel
• onClose
• onNo
• onOpen
• preWrap
• preferBSModal
• preferPanel
• providerOptions
• scrollable
• size
• title
• width

Properties

autoDispose

• Optional autoDispose: boolean

Auto dispose dialog on close, default is true

Inherited from

MessageDialogOptions.autoDispose

Defined in

src/base/dialogs.ts:35

---

autoOpen

• Optional autoOpen: boolean

True to auto open dialog

Inherited from

MessageDialogOptions.autoOpen

Defined in

src/base/dialogs.ts:37

---

backdrop

• Optional backdrop: boolean | "static"

Backdrop type, static to make it modal, e.g. can't be closed by clicking outside

Inherited from

MessageDialogOptions.backdrop

Defined in

src/base/dialogs.ts:39

---

buttons

• Optional buttons: DialogButton[]

List of buttons to show on the dialog

Inherited from

MessageDialogOptions.buttons

Defined in

src/base/dialogs.ts:41

---

cancelButton

• Optional cancelButton: boolean

True to also add a cancel button

Defined in

src/base/dialogs.ts:822

---

centered

• Optional centered: boolean

Vertically center modal

Inherited from

MessageDialogOptions.centered

Defined in

src/base/dialogs.ts:43

---

closeButton

• Optional closeButton: boolean

Show close button, default is true

Inherited from

MessageDialogOptions.closeButton

Defined in

src/base/dialogs.ts:45

---

closeOnEscape

• Optional closeOnEscape: boolean

Close dialog on escape key. Default is true for message dialogs.

Inherited from

MessageDialogOptions.closeOnEscape

Defined in

src/base/dialogs.ts:47

---

dialogClass

• Optional dialogClass: 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

src/base/dialogs.ts:49

---

element

• Optional element: HTMLElement | ArrayLike<HTMLElement> | (element: HTMLElement) => void

Dialog content/body element, or callback that will populate the content element

Inherited from

MessageDialogOptions.element

Defined in

src/base/dialogs.ts:51

---

fade

• Optional fade: boolean

Enable / disable animation. Default is false for message dialogs, true for other dialogs

Inherited from

MessageDialogOptions.fade

Defined in

src/base/dialogs.ts:53

---

fullScreen

• 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

Inherited from

MessageDialogOptions.fullScreen

Defined in

src/base/dialogs.ts:55

---

htmlEncode

• Optional htmlEncode: boolean

HTML encode the message, default is true

Inherited from

MessageDialogOptions.htmlEncode

Defined in

src/base/dialogs.ts:737

---

modal

• Optional modal: boolean

Modal option for jQuery UI dialog compatibility only. Not to be confused with Bootstrap modal.

Inherited from

MessageDialogOptions.modal

Defined in

src/base/dialogs.ts:57

---

onCancel

• Optional onCancel: () => void

Event handler for cancel button click

Type declaration

▸ (): void

Returns

void

Defined in

src/base/dialogs.ts:824

---

onClose

• Optional onClose: (result: string, e?: Event) => void

Event handler that is called when dialog is closed

Type declaration

▸ (result, e?): void

Parameters

Name	Type
result	string
e?	Event

Returns

void

Inherited from

MessageDialogOptions.onClose

Defined in

src/base/dialogs.ts:61

---

onNo

• Optional onNo: () => void

Event handler for no button click

Type declaration

▸ (): void

Returns

void

Defined in

src/base/dialogs.ts:826

---

onOpen

• Optional onOpen: (e?: Event) => void

Event handler that is called when dialog is opened

Type declaration

▸ (e?): void

Parameters

Name	Type
e?	Event

Returns

void

Inherited from

MessageDialogOptions.onOpen

Defined in

src/base/dialogs.ts:59

---

preWrap

• Optional preWrap: boolean

Wrap the message in a <pre> element, so that line endings are preserved, default is true

Inherited from

MessageDialogOptions.preWrap

Defined in

src/base/dialogs.ts:739

---

preferBSModal

• Optional preferBSModal: boolean

Prefer Bootstrap modals to jQuery UI dialogs when both are available

Inherited from

MessageDialogOptions.preferBSModal

Defined in

src/base/dialogs.ts:63

---

preferPanel

• Optional preferPanel: boolean

Prefer Panel even when Modal / jQuery UI is available

Inherited from

MessageDialogOptions.preferPanel

Defined in

src/base/dialogs.ts:65

---

providerOptions

• Optional providerOptions: (type: DialogType, opt: DialogOptions) => any

Callback to get options specific to the dialog provider type

Type declaration

▸ (type, opt): any

Parameters

Name	Type
type	DialogType
opt	DialogOptions

Returns

any

Inherited from

MessageDialogOptions.providerOptions

Defined in

src/base/dialogs.ts:67

---

scrollable

• Optional scrollable: boolean

Scrollable, sets content of the modal to scrollable, only for Bootstrap

Inherited from

MessageDialogOptions.scrollable

Defined in

src/base/dialogs.ts:69

---

size

• Optional size: "sm" | "md" | "lg" | "xl"

Size. Default is null for (500px) message dialogs, lg for normal dialogs

Inherited from

MessageDialogOptions.size

Defined in

src/base/dialogs.ts:71

---

title

• Optional title: string

Dialog title

Inherited from

MessageDialogOptions.title

Defined in

src/base/dialogs.ts:73

---

width

• Optional width: number

Only used for jQuery UI dialogs for backwards compatibility

Inherited from

MessageDialogOptions.width

Defined in

src/base/dialogs.ts:75