ToggleOptions

Defined in: ui/widgets/toggle.ts:15

Properties

background?

optional background?: UIVisualInit

Defined in: ui/widgets/toggle.ts:22

Background renderer for the frame.

---

check?

optional check?: object

Defined in: ui/widgets/toggle.ts:33

Optional rendering for the on-state indicator (“check mark”). A child entity hidden when off, shown when on. Fills the parent by default; override via check.node.

color?

optional color?: Color

node?

optional node?: UINodeInit

sprite?

optional sprite?: number

---

disabled?

optional disabled?: boolean

Defined in: ui/widgets/toggle.ts:42

Start disabled.

---

events

events: EntityEventQueue

Defined in: ui/widgets/toggle.ts:17

---

focusable?

optional focusable?: boolean

Defined in: ui/widgets/toggle.ts:44

Participate in Tab traversal + Enter/Space activation. Default true.

---

interactionStates?

optional interactionStates?: Record<string, ButtonStateVisual>

Defined in: ui/widgets/toggle.ts:26

Interaction states (normal / hover / pressed / disabled) for the frame. Defaults to the active theme’s control roles (as createButton).

---

isOn?

optional isOn?: boolean

Defined in: ui/widgets/toggle.ts:40

Initial on/off state.

---

node?

optional node?: UINodeInit

Defined in: ui/widgets/toggle.ts:19

---

onChange?

optional onChange?: (isOn, entity) => void

Defined in: ui/widgets/toggle.ts:47

Parameters

isOn

boolean

entity

number

Returns

void

---

parent?

optional parent?: number

Defined in: ui/widgets/toggle.ts:18

---

tabIndex?

optional tabIndex?: number

Defined in: ui/widgets/toggle.ts:45

---

world

world: World

Defined in: ui/widgets/toggle.ts:16