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/ToggleOptions.md.

    Interface: ToggleOptions

    Beta

    Options for configuring a toggle component.

    Properties

    description?

    optional description?: string | ObservableString | ObservableUIRawMessage | UIRawMessage

    Beta

    Remarks

    Descriptive text shown around the toggle to provide additional context.

    disabled?

    optional disabled?: boolean | ObservableBoolean

    Beta

    Remarks

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

    tooltip?

    optional tooltip?: string | ObservableString | ObservableUIRawMessage | UIRawMessage

    Beta

    Remarks

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

    visible?

    optional visible?: boolean | ObservableBoolean

    Beta

    Remarks

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

    源码