#Interface: SliderOptions

Beta

Options for configuring a slider component.

#Properties

#description?

optional description?: string | ObservableString | ObservableUIRawMessage | UIRawMessage

Beta

#Remarks

Descriptive text shown around the slider to provide additional context.

---

#disabled?

optional disabled?: boolean | ObservableBoolean

Beta

#Remarks

When true or bound to a true ObservableBoolean, the slider is shown but cannot be moved.

---

#fixedFormatDigits?

optional fixedFormatDigits?: number | ObservableNumber

Beta

#Remarks

If set, displays the number of digits after the decimal point in fixed-point notation. For example, if set to 2, the value 3.14159 will be displayed as 3.14.

---

#step?

optional step?: number | ObservableNumber

Beta

#Remarks

The increment amount between each slider step. Defaults to 1 if not specified.

---

#tooltip?

optional tooltip?: string | ObservableString | ObservableUIRawMessage | UIRawMessage

Beta

#Remarks

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

---

#visible?

optional visible?: boolean | ObservableBoolean

Beta

#Remarks

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