Logo

Slider

Slider provides an interactive control for selecting numeric values within a defined range, supporting both single value selection and range selection with multiple thumbs. It offers precise control through customizable steps and visual feedback with formatted value display.
Key features:
  • Range selection: Single value or dual-thumb range selection with configurable minimum separation
  • Step control: Precise incremental selection with customizable step values
  • Value formatting: Custom display formatting for current values and visual feedback

Properties

autoFocus (default: false)

If this property is set to true, the component gets the focus automatically when displayed.

enabled (default: true)

This boolean property value indicates whether the component responds to user events (true) or not (false).

initialValue

This property sets the component's initial value.

label

This property sets the label of the component. If not set, the component will not display a label.

labelBreak (default: true)

This boolean value indicates whether the Slider label can be split into multiple lines if it would overflow the available label width.

labelPosition (default: "top")

Places the label at the given position of the component.
Available values:
ValueDescription
startThe left side of the input (left-to-right) or the right side of the input (right-to-left)
endThe right side of the input (left-to-right) or the left side of the input (right-to-left)
topThe top of the input (default)
bottomThe bottom of the input

labelWidth

This property sets the width of the Slider component's label. If not defined, the label's width will be determined by its content and the available space.

maxValue (default: 10)

This property specifies the maximum value of the allowed input range.

minStepsBetweenThumbs (default: 1)

This property sets the minimum number of steps required between multiple thumbs on the slider, ensuring they maintain a specified distance.

minValue (default: 0)

This property specifies the minimum value of the allowed input range.

rangeStyle

This optional property allows you to apply custom styles to the range element of the slider.

readOnly (default: false)

Set this property to true to disallow changing the component value.

required (default: false)

Set this property to true to indicate it must have a value before submitting the containing form.

showValues (default: true)

This property controls whether the slider shows the current values of the thumbs.

step (default: 1)

This property defines the increment value for the slider, determining the allowed intervals between selectable values.

thumbStyle

This optional property allows you to apply custom styles to the thumb elements of the slider.

validationStatus (default: "none")

This property allows you to set the validation status of the input component.
Available values:
ValueDescription
validVisual indicator for an input that is accepted
warningVisual indicator for an input that produced a warning
errorVisual indicator for an input that produced an error

valueFormat (default: "(value) => value.toString()")

This property allows you to customize how the values are displayed.

Events

didChange

This event is triggered when value of Slider has changed.

gotFocus

This event is triggered when the Slider has received the focus.

lostFocus

This event is triggered when the Slider has lost the focus.

Exposed Methods

focus

This method sets the focus on the slider component.
Signature: focus(): void

setValue

This API sets the value of the Slider. You can use it to programmatically change the value.
Signature: setValue(value: number | [number, number] | undefined): void
  • value: The new value to set. Can be a single value or an array of values for range sliders.

value

This API retrieves the current value of the Slider. You can use it to get the value programmatically.
Signature: get value(): number | [number, number] | undefined

Styling

Theme Variables

VariableDefault Value (Light)Default Value (Dark)
backgroundColor-range-Slider$color-primary$color-primary
backgroundColor-range-Slider$color-primary$color-primary
backgroundColor-range-Slider--disabled$color-surface-400$color-surface-800
backgroundColor-range-Slider--disabled$color-surface-400$color-surface-800
backgroundColor-thumb-Slider$color-primary-500$color-primary-400
backgroundColor-thumb-Slider$color-primary-500$color-primary-400
backgroundColor-track-Slider$color-surface-200$color-surface-200
backgroundColor-track-Slider$color-surface-200$color-surface-200
backgroundColor-track-Slider--disabled$color-surface-300$color-surface-600
backgroundColor-track-Slider--disabled$color-surface-300$color-surface-600
borderColor-Slider-defaulttransparenttransparent
borderColor-Slider-defaulttransparenttransparent
borderColor-Slider-default--focusnonenone
borderColor-Slider-default--hovernonenone
borderColor-Slider-errornonenone
borderColor-Slider-error--focusnonenone
borderColor-Slider-error--hovernonenone
borderColor-Slider-successnonenone
borderColor-Slider-success--focusnonenone
borderColor-Slider-success--hovernonenone
borderColor-Slider-warningnonenone
borderColor-Slider-warning--focusnonenone
borderColor-Slider-warning--hovernonenone
borderColor-thumb-Slider$color-surface-50$color-surface-950
borderColor-thumb-Slider$color-surface-50$color-surface-950
borderRadius-Slider-default$borderRadius$borderRadius
borderRadius-Slider-default$borderRadius$borderRadius
borderRadius-Slider-errornonenone
borderRadius-Slider-successnonenone
borderRadius-Slider-warningnonenone
borderStyle-Slider-defaultsolidsolid
borderStyle-Slider-defaultsolidsolid
borderStyle-Slider-errornonenone
borderStyle-Slider-successnonenone
borderStyle-Slider-warningnonenone
borderStyle-thumb-Slidersolidsolid
borderStyle-thumb-Slidersolidsolid
borderWidth-Slider-default00
borderWidth-Slider-default00
borderWidth-Slider-errornonenone
borderWidth-Slider-successnonenone
borderWidth-Slider-warningnonenone
borderWidth-thumb-Slider2px2px
borderWidth-thumb-Slider2px2px
boxShadow-Slider-defaultnonenone
boxShadow-Slider-defaultnonenone
boxShadow-Slider-default--focusnonenone
boxShadow-Slider-default--hovernonenone
boxShadow-Slider-errornonenone
boxShadow-Slider-error--focusnonenone
boxShadow-Slider-error--hovernonenone
boxShadow-Slider-successnonenone
boxShadow-Slider-success--focusnonenone
boxShadow-Slider-success--hovernonenone
boxShadow-Slider-warningnonenone
boxShadow-Slider-warning--focusnonenone
boxShadow-Slider-warning--hovernonenone
boxShadow-thumb-Slider$boxShadow-md$boxShadow-md
boxShadow-thumb-Slider$boxShadow-md$boxShadow-md
boxShadow-thumb-Slider--focus$boxShadow-xl$boxShadow-xl
boxShadow-thumb-Slider--hover$boxShadow-lg$boxShadow-lg
This site is an XMLUI™ app.