@serenity-is/corelib / DialogButton

Interface: DialogButton

Options for a message dialog button

Table of contents

Properties

• click
• cssClass
• hint
• icon
• result
• text

Properties

click

• Optional click: (e: MouseEvent) => false | void | Promise<false | void>

Click handler

Type declaration

▸ (e): false | void | Promise<false | void>

Parameters

Name	Type
e	MouseEvent

Returns

false | void | Promise<false | void>

Defined in

src/base/dialogs.ts:19

---

cssClass

• Optional cssClass: string

CSS class for button

Defined in

src/base/dialogs.ts:21

---

hint

• Optional hint: string

Button hint

Defined in

src/base/dialogs.ts:15

---

icon

• Optional icon: IconClassName

Button icon

Defined in

src/base/dialogs.ts:17

---

result

• Optional result: string

The code that is returned from message dialog function when this button is clicked. If this is set, and click event will not be defaultPrevented dialog will close.

Defined in

src/base/dialogs.ts:25

---

text

• Optional text: string

Button text

Defined in

src/base/dialogs.ts:13