@serenity-is/corelib / DialogOptions

Interface: DialogOptions

Options that apply to all dialog types

Hierarchy

• DialogOptions

  ↳ MessageDialogOptions

Table of contents

Properties

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

Properties

autoDispose

• Optional autoDispose: boolean

Auto dispose dialog on close, default is true

Defined in

src/base/dialogs.ts:35

---

autoOpen

• Optional autoOpen: boolean

True to auto open dialog

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

Defined in

src/base/dialogs.ts:39

---

buttons

• Optional buttons: DialogButton[]

List of buttons to show on the dialog

Defined in

src/base/dialogs.ts:41

---

centered

• Optional centered: boolean

Vertically center modal

Defined in

src/base/dialogs.ts:43

---

closeButton

• Optional closeButton: boolean

Show close button, default is true

Defined in

src/base/dialogs.ts:45

---

closeOnEscape

• Optional closeOnEscape: boolean

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

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

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

Defined in

src/base/dialogs.ts:51

---

fade

• Optional fade: boolean

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

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

Defined in

src/base/dialogs.ts:55

---

modal

• Optional modal: boolean

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

Defined in

src/base/dialogs.ts:57

---

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

Defined in

src/base/dialogs.ts:61

---

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

Defined in

src/base/dialogs.ts:59

---

preferBSModal

• Optional preferBSModal: boolean

Prefer Bootstrap modals to jQuery UI dialogs when both are available

Defined in

src/base/dialogs.ts:63

---

preferPanel

• Optional preferPanel: boolean

Prefer Panel even when Modal / jQuery UI is available

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

Defined in

src/base/dialogs.ts:67

---

scrollable

• Optional scrollable: boolean

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

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

Defined in

src/base/dialogs.ts:71

---

title

• Optional title: string

Dialog title

Defined in

src/base/dialogs.ts:73

---

width

• Optional width: number

Only used for jQuery UI dialogs for backwards compatibility

Defined in

src/base/dialogs.ts:75