Components

Slider

An input where the user selects a value from within a given range.

import React from 'react';
import * as Slider from '@radix-ui/react-slider';
import './styles.css';
const SliderDemo = () => (
<form>
<Slider.Root className="SliderRoot" defaultValue={[50]} max={100} step={1}>
<Slider.Track className="SliderTrack">
<Slider.Range className="SliderRange" />
</Slider.Track>
<Slider.Thumb className="SliderThumb" aria-label="Volume" />
</Slider.Root>
</form>
);
export default SliderDemo;

Features

    Can be controlled or uncontrolled.

    Supports multiple thumbs.

    Supports a minimum value between thumbs.

    Supports touch or click on track to update value.

    Supports Right to Left direction.

    Full keyboard navigation.

Installation

Install the component from your command line.

npm install @radix-ui/react-slider

Anatomy

Import all parts and piece them together.

import * as Slider from '@radix-ui/react-slider';
export default () => (
<Slider.Root>
<Slider.Track>
<Slider.Range />
</Slider.Track>
<Slider.Thumb />
</Slider.Root>
);

API Reference

Root

Contains all the parts of a slider. It will render an input for each thumb when used within a form to ensure events propagate correctly.

PropTypeDefault
asChild
boolean
false
defaultValue
number[]
No default value
value
number[]
No default value
onValueChange
function
No default value
onValueCommit
function
No default value
name
string
No default value
disabled
boolean
false
orientation
enum
"horizontal"
dir
enum
No default value
inverted
boolean
false
min
number
0
max
number
100
step
number
1
minStepsBetweenThumbs
number
0
Data attributeValues
[data-disabled]

Present when disabled

[data-orientation]"vertical" | "horizontal"

Track

The track that contains the Slider.Range.

PropTypeDefault
asChild
boolean
false
Data attributeValues
[data-disabled]

Present when disabled

[data-orientation]"vertical" | "horizontal"

Range

The range part. Must live inside Slider.Track.

PropTypeDefault
asChild
boolean
false
Data attributeValues
[data-disabled]

Present when disabled

[data-orientation]"vertical" | "horizontal"

Thumb

A draggable thumb. You can render multiple thumbs.

PropTypeDefault
asChild
boolean
false
Data attributeValues
[data-disabled]

Present when disabled

[data-orientation]"vertical" | "horizontal"

Examples

Vertical orientation

Use the orientation prop to create a vertical slider.

// index.jsx
import * as Slider from '@radix-ui/react-slider';
import './styles.css';
export default () => (
<Slider.Root className="SliderRoot" defaultValue={[50]} orientation="vertical" >
<Slider.Track className="SliderTrack">
<Slider.Range className="SliderRange" />
</Slider.Track>
<Slider.Thumb className="SliderThumb" />
</Slider.Root>
);
/* styles.css */
.SliderRoot {
position: relative;
display: flex;
align-items: center;
}
.SliderRoot[data-orientation='vertical'] {
flex-direction: column;
width: 20px;
height: 100px;
}
.SliderTrack {
position: relative;
flex-grow: 1;
background-color: grey;
}
.SliderTrack[data-orientation='vertical'] {
width: 3px;
}
.SliderRange {
position: absolute;
background-color: black;
}
.SliderRange[data-orientation='vertical'] {
width: 100%;
}
.SliderThumb {
display: block;
width: 20px;
height: 20px;
background-color: black;
}

Create a range

Add multiple thumbs and values to create a range slider.

import * as Slider from '@radix-ui/react-slider';
export default () => (
<Slider.Root defaultValue={[25, 75]}>
<Slider.Track>
<Slider.Range />
</Slider.Track>
<Slider.Thumb />
<Slider.Thumb />
</Slider.Root>
);

Define step size

Use the step prop to increase the stepping interval.

import * as Slider from '@radix-ui/react-slider';
export default () => (
<Slider.Root defaultValue={[50]} step={10}>
<Slider.Track>
<Slider.Range />
</Slider.Track>
<Slider.Thumb />
</Slider.Root>
);

Prevent thumb overlap

Use minStepsBetweenThumbs to avoid thumbs with equal values.

import * as Slider from '@radix-ui/react-slider';
export default () => (
<Slider.Root defaultValue={[25, 75]} step={10} minStepsBetweenThumbs={1}>
<Slider.Track>
<Slider.Range />
</Slider.Track>
<Slider.Thumb />
<Slider.Thumb />
</Slider.Root>
);

Accessibility

Adheres to the Slider WAI-ARIA design pattern.

Keyboard Interactions

KeyDescription
ArrowRight
Increments/decrements by the step value depending on orientation.
ArrowLeft
Increments/decrements by the step value depending on orientation.
ArrowUp
Increases the value by the step amount.
ArrowDown
Decreases the value by the step amount.
PageUp
Increases the value by a larger step.
PageDown
Decreases the value by a larger step.
Shift + ArrowUp
Increases the value by a larger step.
Shift + ArrowDown
Decreases the value by a larger step.
Home
Sets the value to its minimum.
End
Sets the value to its maximum.

Custom APIs

Create your own API by abstracting the primitive parts into your own component.

Abstract all parts

This example abstracts all of the Slider parts so it can be used as a self closing element.

Usage

import { Slider } from './your-slider';
export default () => <Slider defaultValue={[25]} />;

Implementation

// your-slider.jsx
import * as SliderPrimitive from '@radix-ui/react-slider';
export const Slider = React.forwardRef((props, forwardedRef) => {
const value = props.value || props.defaultValue;
return (
<SliderPrimitive.Slider {...props} ref={forwardedRef}>
<SliderPrimitive.Track>
<SliderPrimitive.Range />
</SliderPrimitive.Track>
{value.map((_, i) => (
<SliderThumb key={i} />
))}
</SliderPrimitive.Slider>
);
});

Caveats

Mouse events are not fired

Because of a limitation we faced during implementation, the following example won't work as expected and the onMouseDown and onMouseUp event handlers won't be fired:

<Slider.Root onMouseDown={() => console.log('onMouseDown')} onMouseUp={() => console.log('onMouseUp')} >
</Slider.Root>

We recommend using pointer events instead (eg. onPointerDown, onPointerUp). Regardless of the above limitation, these events are better suited for cross-platform/device handling as they are fired for all pointer input types (mouse, touch, pen, etc.).

PreviousSeparator
NextSwitch