DialogOptions

Defined in: components/dialog.ts:8

Options for dialog.

Properties

header?

optional header?: Slot

Defined in: components/dialog.ts:10

Slot rendered in the styled header bar.

---

footer?

optional footer?: Slot

Defined in: components/dialog.ts:12

Slot rendered in the styled footer bar.

---

attrs?

optional attrs?: string

Defined in: components/dialog.ts:14

Aberdeen attr/style string applied to the dialog panel. A surface — pass modifier classes (e.g. ".warning") to recolour it.

---

headerAttrs?

optional headerAttrs?: string

Defined in: components/dialog.ts:16

Aberdeen attr/style string applied to the header bar.

---

footerAttrs?

optional footerAttrs?: string

Defined in: components/dialog.ts:18

Aberdeen attr/style string applied to the footer bar.

---

contentAttrs?

optional contentAttrs?: string

Defined in: components/dialog.ts:20

Aberdeen attr/style string applied to the scrollable content <div>.

---

allowCancel?

optional allowCancel?: boolean

Defined in: components/dialog.ts:26

Allow closing via Esc or clicking the backdrop. Defaults to true. May be changed on a proxied options object while the dialog is open (e.g. lock when form data is dirty).

---

cancelWithScope?

optional cancelWithScope?: boolean

Defined in: components/dialog.ts:31

When set to true (default) the model will be destroyed when the dialog()-calling scope is destroyed.

---

content?

optional content?: Slot<[() => void]>

Defined in: components/dialog.ts:37

Dialog body. A Slot whose draw-function receives a close() function — call it to dismiss the dialog programmatically. (A plain string renders as rich text.)

---

onClose?

optional onClose?: () => void

Defined in: components/dialog.ts:43

Called when the dialog closes for any reason (explicit close(), Esc, or backdrop click). Useful when you want a side-effect on close but don’t need the Promise returned by dialog.

Returns

void