1681-engine / ui / DialogOptions

Interface: DialogOptions

Defined in: src/ui/Dialog.ts:8

Properties

content

content: Container;

Defined in: src/ui/Dialog.ts:17

The body: a Stack of text and buttons, anything. Laid padding in from the frame.

---

dimAlpha?

optional dimAlpha?: number;

Defined in: src/ui/Dialog.ts:21

---

dimColor?

optional dimColor?: number;

Defined in: src/ui/Dialog.ts:20

The screen behind it is dimmed by this (default black at 0.5); every press on it is eaten.

---

dismissable?

optional dismissable?: boolean;

Defined in: src/ui/Dialog.ts:23

Cancel (Esc, the pad's B) or a press outside closes it (default true).

---

frame

frame: PanelSkin;

Defined in: src/ui/Dialog.ts:15

---

height?

optional height?: number;

Defined in: src/ui/Dialog.ts:14

The window's height. Left out, it is the content's height plus the padding above and below, measured again whenever the dialog is laid out (UiRoot.layout() after the content changed size).

---

margin?

optional margin?: number;

Defined in: src/ui/Dialog.ts:25

Kept clear of the screen's edges (default 8).

---

onClose?

optional onClose?: () => void;

Defined in: src/ui/Dialog.ts:26

Returns

void

---

padding?

optional padding?: number;

Defined in: src/ui/Dialog.ts:18

---

width

width: number;

Defined in: src/ui/Dialog.ts:9