For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-ui/interfaces/ButtonOptions.md.

Interface: ButtonOptions

Beta

Options for configuring a button component.

Properties

disabled?

optional disabled?: boolean | ObservableBoolean

Beta

Remarks

When true or bound to a true ObservableBoolean, the button is shown but cannot be pressed.


imageDetails?

optional imageDetails?: ImageDetails

Beta

Remarks

Details of an image to display alongside the button label.


tooltip?

optional tooltip?: string | ObservableString | ObservableUIRawMessage | UIRawMessage

Beta

Remarks

Text shown in a tooltip when the player hovers over the button.


visible?

optional visible?: boolean | ObservableBoolean

Beta

Remarks

When false or bound to a false ObservableBoolean, the button is hidden.