ButtonOptions

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

Extended by

• VirtualButtonOptions

Properties

background?

optional background?: UIVisualInit

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

Background renderer config. Default: solid white quad.

---

disabled?

optional disabled?: boolean

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

Start in the disabled state (Interactable.enabled = false).

---

events

events: EntityEventQueue

Defined in: ui/widgets/button.ts:28

---

fadeDuration?

optional fadeDuration?: number

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

Tween time for color/scale state changes. Default 0 (snap).

---

focusable?

optional focusable?: boolean

Defined in: ui/widgets/button.ts:49

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

---

node?

optional node?: UINodeInit

Defined in: ui/widgets/button.ts:31

CSS-box layout. Default: fill the parent.

---

onClick?

optional onClick?: (entity) => void

Defined in: ui/widgets/button.ts:52

Parameters

entity

number

Returns

void

---

parent?

optional parent?: number

Defined in: ui/widgets/button.ts:29

---

states?

optional states?: Record<string, ButtonStateVisual>

Defined in: ui/widgets/button.ts:43

Map of state name (e.g. “normal”, “hover”, “pressed”, “disabled”) to its visual override. The $interaction driver writes the four canonical state names; callers may add more (e.g. “loading”) and flip them manually via setButtonState. Omit to default to the active theme’s control roles (themeButtonStates).

---

tabIndex?

optional tabIndex?: number

Defined in: ui/widgets/button.ts:51

Tab order within the focus ring. Default 0 (document order).

---

text?

optional text?: string | TextInit

Defined in: ui/widgets/button.ts:35

Label text. Omit to skip spawning a child label entity.

---

userGesture?

optional userGesture?: boolean

Defined in: ui/widgets/button.ts:56

Run onClick inside the host’s own release event rather than on the next frame, for a call a host accepts only from a player’s gesture (sharing a recording on WeChat).

---

world

world: World

Defined in: ui/widgets/button.ts:27