Skip to content

Slider API

API reference docs for the React Slider component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Slider from '@mui/joy/Slider';
// or
import { Slider } from '@mui/joy';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name JoySlider can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
aria-labelstring
The label of the slider.
aria-valuetextstring
A string value that provides a user-friendly name for the current value of the slider.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
color'danger'
| 'info'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'primary'
The color of the component. It supports those theme colors that make sense for this component.
defaultValueArray<number>
| number
The default value. Use when the component is not controlled.
disabledboolfalse
If true, the component is disabled.
disableSwapboolfalse
If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.
getAriaLabelfunc
Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

Signature:
function(index: number) => string
index: The thumb label's index to format.
getAriaValueTextfunc
Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.

Signature:
function(value: number, index: number) => string
value: The thumb label's value to format.
index: The thumb label's index to format.
isRtlboolfalse
If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).
marksArray<{ label?: node, value: number }>
| bool
false
Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.
maxnumber100
The maximum allowed value of the slider. Should not be equal to min.
minnumber0
The minimum allowed value of the slider. Should not be equal to max.
namestring
Name attribute of the hidden input element.
onChangefunc
Callback function that is fired when the slider's value changed.

Signature:
function(event: Event, value: number | Array<number>, activeThumb: number) => void
event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.
value: The new value.
activeThumb: Index of the currently moved thumb.
onChangeCommittedfunc
Callback function that is fired when the mouseup is triggered.

Signature:
function(event: React.SyntheticEvent | Event, value: number | Array<number>) => void
event: The event source of the callback. Warning: This is a generic event not a change event.
value: The new value.
orientation'horizontal'
| 'vertical'
'horizontal'
The component orientation.
scalefuncfunction Identity(x) { return x; }
A transformation function, to change the scale of the slider.

Signature:
function(x: any) => any
size'sm'
| 'md'
| 'lg'
| string
'md'
The size of the component. It accepts theme values between 'sm' and 'lg'.
stepnumber1
The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.
When step is null, the thumb can only be slid onto marks provided with the marks prop.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
tabIndexnumber
Tab index attribute of the hidden input element.
track'inverted'
| 'normal'
| false
'normal'
The track presentation:
- normal the track will render a bar representing the slider value. - inverted the track will render a bar representing the remaining slider value. - false the track will render without a bar.
valueArray<number>
| number
The value of the slider. For ranged sliders, provide an array with two values.
valueLabelDisplay'auto'
| 'off'
| 'on'
'off'
Controls when the value label is displayed:
- auto the value label will display when the thumb is hovered or focused. - on will display persistently. - off will never display.
valueLabelFormatfunc
| string
function Identity(x) { return x; }
The format function the value label's value.
When a function is provided, it should have the following signature:
- {number} value The value label's value to format - {number} index The value label's index to format
variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
'solid'
The variant to use.

The ref is forwarded to the root element.

CSS

Rule nameGlobal classDescription
root.MuiSlider-rootClass name applied to the root element.
marked.MuiSlider-markedClass name applied to the root element if marks is provided with at least one label.
vertical.MuiSlider-verticalClass name applied to the root element if orientation="vertical".
disabled.Mui-disabledState class applied to the root and thumb element if disabled={true}.
dragging.MuiSlider-draggingState class applied to the root if a thumb is being dragged.
rail.MuiSlider-railClass name applied to the rail element.
track.MuiSlider-trackClass name applied to the track element.
trackFalse.MuiSlider-trackFalseClass name applied to the root element if track={false}.
trackInverted.MuiSlider-trackInvertedClass name applied to the root element if track="inverted".
thumb.MuiSlider-thumbClass name applied to the thumb element.
active.Mui-activeState class applied to the thumb element if it's active.
focusVisible.Mui-focusVisibleState class applied to the thumb element if keyboard focused.
mark.MuiSlider-markClass name applied to the mark element.
markActive.MuiSlider-markActiveClass name applied to the mark element if active (depending on the value).
markLabel.MuiSlider-markLabelClass name applied to the mark label element.
markLabelActive.MuiSlider-markLabelActiveClass name applied to the mark label element if active (depending on the value).

You can override the style of the component using one of these customization options: