Skip to content

@minecraft/server-ui


@minecraft/server-ui / ToggleOptions

Interface: ToggleOptions

Defined in: @minecraft/server-ui/index.d.ts:1823

Options for configuring a toggle component.

Properties

description?

optional description?: string | ObservableString | ObservableUIRawMessage | UIRawMessage

Defined in: @minecraft/server-ui/index.d.ts:1830

Remarks

Descriptive text shown around the toggle to provide additional context.


disabled?

optional disabled?: boolean | ObservableBoolean

Defined in: @minecraft/server-ui/index.d.ts:1837

Remarks

When true or bound to a true ObservableBoolean, the toggle is shown but cannot be interacted with.


visible?

optional visible?: boolean | ObservableBoolean

Defined in: @minecraft/server-ui/index.d.ts:1844

Remarks

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