Slider

A slider allows a user to select one or more values within a range.

Theme 
0
orientation 
isDisabled 
formatOptions 
Example
Slider.tsx
Slider.css
import {Slider} from './Slider';

<Slider label="Opacity" />

Value

Use the value or defaultValue prop to set the slider's value. The onChange event is called as the user drags, and onChangeEnd is called when the thumb is released.

25
onChange value: 25
onChangeEnd value: 25
import {Slider} from './Slider';
import {useState} from 'react';

function Example() {
  let [currentValue, setCurrentValue] = useState(25);
  let [finalValue, setFinalValue] = useState(currentValue);

  return (
    <>
      <Slider
        label="Cookies to buy"
        value={currentValue}
        onChange={setCurrentValue}
        onChangeEnd={setFinalValue} />
      <pre style={{fontSize: 12}}>
        onChange value: {currentValue}{'\n'}
        onChangeEnd value: {finalValue}
      </pre>
    </>
  );
}

Multi-thumb

Set the value or defaultValue to an array of numbers to render multiple thumbs. Each thumb should have an aria-label to describe it for assistive technologies (provided via thumbLabels here).

30 – 60
import {Slider} from './Slider';

<Slider
  label="Range"
  defaultValue={[30, 60]}
  thumbLabels={['start', 'end']} />

Value scale

By default, slider values are percentages between 0 and 100. Use the minValue, maxValue, and step props to set the allowed values. Steps are calculated starting from the minimum. For example, if minValue={2}, and step={3}, the valid step values would be 2, 5, 8, 11, etc.

50
 
 
 
<Slider
  label="Amount"
  maxValue={150}
  defaultValue={50}
  step={5} />

Examples

API

Shows a slider with labels pointing to its parts including the label, group, track, thumb, and output elements.OutputLabelLabelLabel24TrackThumbGroup
<Slider>
  <Label />
  <SliderOutput />
  <SliderTrack>
    <SliderThumb />
    <SliderThumb>
      <Label />
    </SliderThumb>
  </SliderTrack>
</Slider>

Slider

A slider allows a user to select one or more values within a range.

NameTypeDefault
orientationDefault: 'horizontal'
The orientation of the Slider.
isDisabledbooleanDefault:
Whether the whole Slider is disabled.
children<>Default:
The children of the component. A function may be provided to alter the children based on component state.
valueTDefault:
The current value (controlled).
defaultValueTDefault:
The default value (uncontrolled).
onChange(value: T) => voidDefault:
Handler that is called when the value changes.
onChangeEnd(value: T) => voidDefault:
Fired when the slider stops moving, due to being let go.
formatOptionsIntl.NumberFormatOptionsDefault:
The display format of the value label.

Default className: react-aria-Slider

Render PropCSS Selector
orientationCSS Selector: [data-orientation="horizontal | vertical"]
The orientation of the slider.
isDisabledCSS Selector: [data-disabled]
Whether the slider is disabled.
stateCSS Selector:
State of the slider.

SliderOutput

A slider output displays the current value of a slider as text.

NameType
children<>
The children of the component. A function may be provided to alter the children based on component state.

Default className: react-aria-SliderOutput

Render PropCSS Selector
orientationCSS Selector: [data-orientation="horizontal | vertical"]
The orientation of the slider.
isDisabledCSS Selector: [data-disabled]
Whether the slider is disabled.
stateCSS Selector:
State of the slider.

SliderTrack

A slider track is a container for one or more slider thumbs.

NameType
children<>
The children of the component. A function may be provided to alter the children based on component state.

Default className: react-aria-SliderTrack

Render PropCSS Selector
isHoveredCSS Selector: [data-hovered]
Whether the slider track is currently hovered with a mouse.
orientationCSS Selector: [data-orientation="horizontal | vertical"]
The orientation of the slider.
isDisabledCSS Selector: [data-disabled]
Whether the slider is disabled.
stateCSS Selector:
State of the slider.

SliderThumb

A slider thumb represents an individual value that the user can adjust within a slider track.

NameTypeDefault
inputRef<HTMLInputElementnull>Default:
A ref for the HTML input element.
isDisabledbooleanDefault:
Whether the Thumb is disabled.
indexnumberDefault: 0
Index of the thumb within the slider.
children<>Default:
The children of the component. A function may be provided to alter the children based on component state.

Default className: react-aria-SliderThumb

Render PropCSS Selector
stateCSS Selector:
State of the slider.
isDraggingCSS Selector: [data-dragging]
Whether this thumb is currently being dragged.
isHoveredCSS Selector: [data-hovered]
Whether the thumb is currently hovered with a mouse.
isFocusedCSS Selector: [data-focused]
Whether the thumb is currently focused.
isFocusVisibleCSS Selector: [data-focus-visible]
Whether the thumb is keyboard focused.
isDisabledCSS Selector: [data-disabled]
Whether the thumb is disabled.