@serenity-is/corelib / Dialog

Class: Dialog

Table of contents

Constructors

• constructor

Properties

• defaults
• messageDefaults

Accessors

• result
• type

Methods

• close
• createBSModal
• createUIDialog
• dispose
• getContentNode
• getDialogNode
• getEventsNode
• getFooterNode
• getHeaderNode
• onClose
• onOpen
• open
• title
• getInstance

Constructors

constructor

• new Dialog(opt?): Dialog

Parameters

Name	Type
opt?	DialogOptions

Returns

Dialog

Defined in

src/base/dialogs.ts:83

Properties

defaults

▪ Static defaults: DialogOptions

Defined in

src/base/dialogs.ts:132

---

messageDefaults

▪ Static messageDefaults: MessageDialogOptions

Defined in

src/base/dialogs.ts:145

Accessors

result

• get result(): string

The result code of the button that is clicked. Also attached to the dialog element as data-dialog-result

Returns

string

Defined in

src/base/dialogs.ts:169

---

type

• get type(): DialogType

Returns

DialogType

Defined in

src/base/dialogs.ts:262

Methods

close

▸ close(): this

Closes dialog setting the result to null

Returns

this

Defined in

src/base/dialogs.ts:174

▸ close(result): this

Closes dialog with the result set to value

Parameters

Name	Type
result	string

Returns

this

Defined in

src/base/dialogs.ts:176

---

createBSModal

▸ createBSModal(opt): void

Parameters

Name	Type
opt	DialogOptions

Returns

void

Defined in

src/base/dialogs.ts:326

---

createUIDialog

▸ createUIDialog(opt): void

Parameters

Name	Type
opt	DialogOptions

Returns

void

Defined in

src/base/dialogs.ts:439

---

dispose

▸ dispose(): void

Returns

void

Defined in

src/base/dialogs.ts:468

---

getContentNode

▸ getContentNode(): HTMLElement

Gets the body/content element of the dialog

Returns

HTMLElement

Defined in

src/base/dialogs.ts:276

---

getDialogNode

▸ getDialogNode(): HTMLElement

Gets the dialog element of the dialog

Returns

HTMLElement

Defined in

src/base/dialogs.ts:281

---

getEventsNode

▸ getEventsNode(): HTMLElement

Gets the node that receives events for the dialog. It's .ui-dialog-content, .modal, or .panel-body

Returns

HTMLElement

Defined in

src/base/dialogs.ts:286

---

getFooterNode

▸ getFooterNode(): HTMLElement

Gets the footer element of the dialog

Returns

HTMLElement

Defined in

src/base/dialogs.ts:291

---

getHeaderNode

▸ getHeaderNode(): HTMLElement

Gets the header element of the dialog

Returns

HTMLElement

Defined in

src/base/dialogs.ts:296

---

onClose

▸ onClose(handler, before?): void

Parameters

Name	Type	Default value
handler	(result?: string, e?: Event) => void	undefined
before	boolean	false

Returns

void

Defined in

src/base/dialogs.ts:202

---

onOpen

▸ onOpen(handler, before?): this

Parameters

Name	Type	Default value
handler	(e?: Event) => void	undefined
before	boolean	false

Returns

this

Defined in

src/base/dialogs.ts:214

---

open

▸ open(): Dialog

Closes dialog

Returns

Dialog

Defined in

src/base/dialogs.ts:228

---

title

▸ title(): string

Gets the title text of the dialog

Returns

string

Defined in

src/base/dialogs.ts:250

▸ title(value): this

Sets the title text of the dialog.

Parameters

Name	Type
value	string

Returns

this

Defined in

src/base/dialogs.ts:252

---

getInstance

▸ getInstance(el): Dialog

Parameters

Name	Type
el	HTMLElement | ArrayLike<HTMLElement>

Returns

Dialog

Defined in

src/base/dialogs.ts:161