Interface ToggleOptions`Beta`

Options for configuring a toggle component.

interface ToggleOptions {
    description?:
        | string
        | ObservableString
        | ObservableUIRawMessage
        | UIRawMessage;
    disabled?: boolean
    | ObservableBoolean;
    visible?: boolean | ObservableBoolean;
}

Index

Properties

description? disabled? visible?

Properties

`Optional`description

description?: string | ObservableString | ObservableUIRawMessage | UIRawMessage

Remarks

Descriptive text shown around the toggle to provide additional context.

`Optional`disabled

disabled?: boolean | ObservableBoolean

Remarks

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

`Optional`visible

visible?: boolean | ObservableBoolean

Remarks

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