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:

Slider

Import

import Slider from '@mui/joy/Slider';
// or
import { Slider } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

aria-label

The label of the slider.

Type:

string

aria-valuetext

A string value that provides a user-friendly name for the current value of the slider.

Type:

string

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object

color

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

Type:

Default:

'primary'

component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType

defaultValue

The default value. Use when the component is not controlled.

Type:

Array<number> | number

disabled

If true, the component is disabled.

Type:

bool

Default:

false

disableSwap

If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.

Type:

bool

Default:

false

getAriaLabel

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.

Type:

func

Signature:

function(index: number) => string

index The thumb label's index to format.

getAriaValueText

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.

Type:

func

Signature:

function(value: number, index: number) => string

value The thumb label's value to format.
index The thumb label's index to format.

isRtl

If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).

Type:

bool

Default:

false

marks

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.

Type:

Array<{ label?: node, value: number }> | bool

Default:

false

max

The maximum allowed value of the slider. Should not be equal to min.

Type:

number

Default:

100

min

The minimum allowed value of the slider. Should not be equal to max.

Type:

number

Default:

0

name

Name attribute of the hidden input element.

Type:

string

onChange

Callback function that is fired when the slider's value changed.

Type:

func

Signature:

function(event: Event, value: number | Array, 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.

onChangeCommitted

Callback function that is fired when the mouseup is triggered.

Type:

func

Signature:

function(event: React.SyntheticEvent | Event, value: number | Array) => void

event The event source of the callback. Warning: This is a generic event not a change event.
value The new value.

orientation

The component orientation.

Type:

'horizontal' | 'vertical'

Default:

'horizontal'

scale

A transformation function, to change the scale of the slider.

Type:

func

Default:

function Identity(x) {
  return x;
}

Signature:

function(x: any) => any

size

The size of the component. It accepts theme values between 'sm' and 'lg'.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

Type:

'sm' | 'md' | 'lg' | string

Default:

'md'

slotProps

The props used for each slot inside.

Type:

{ input?: func | object, mark?: func | object, markLabel?: func | object, rail?: func | object, root?: func | object, thumb?: func | object, track?: func | object, valueLabel?: func | object }

Default:

{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:

{ input?: elementType, mark?: elementType, markLabel?: elementType, rail?: elementType, root?: elementType, thumb?: elementType, track?: elementType, valueLabel?: elementType }

Default:

{}

step

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.

Type:

number

Default:

1

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object

tabIndex

Tab index attribute of the hidden input element.

Type:

number

track

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.

Type:

'inverted' | 'normal' | false

Default:

'normal'

value

The value of the slider. For ranged sliders, provide an array with two values.

Type:

Array<number> | number

valueLabelDisplay

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.

Type:

'auto' | 'off' | 'on'

Default:

'off'

valueLabelFormat

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

Type:

func | string

Default:

function Identity(x) {
  return x;
}

variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'solid'

The ref is forwarded to the root element.

Theme default props

You can use JoySlider to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root

The component that renders the root.

Default: 'span'

Global class: .MuiSlider-root

track

The component that renders the track.

Default: 'span'

Global class: .MuiSlider-track

rail

The component that renders the rail.

Default: 'span'

Global class: .MuiSlider-rail

thumb

The component that renders the thumb.

Default: 'span'

Global class: .MuiSlider-thumb

mark

The component that renders the mark.

Default: 'span'

Global class: .MuiSlider-mark

markLabel

The component that renders the mark label.

Default: 'span'

Global class: .MuiSlider-markLabel

valueLabel

The component that renders the value label.

Default: 'span'

Global class: .MuiSlider-valueLabel

input

The component that renders the input.

Default: 'input'

Global class: .MuiSlider-input

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.Mui-disabledSTATE

State class applied to the root and thumb element if disabled={true}.

.Mui-focusVisibleSTATE

State class applied to the thumb element if it has keyboard focused.

.MuiSlider-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiSlider-colorDanger

Class name applied to the root element if color="danger".

.MuiSlider-colorNeutral

Class name applied to the root element if color="neutral".

.MuiSlider-colorPrimary

Class name applied to the root element if color="primary".

.MuiSlider-colorSuccess

Class name applied to the root element if color="success".

.MuiSlider-colorWarning

Class name applied to the root element if color="warning".

.MuiSlider-dragging

State class applied to the root if a thumb is being dragged.

.MuiSlider-markActive

Class name applied to the mark element when it is active.

.MuiSlider-marked

Class name applied to the root element if marks is provided with at least one label.

.MuiSlider-sizeLg

Class name applied to the root element if size="lg".

.MuiSlider-sizeMd

Class name applied to the root element if size="md".

.MuiSlider-sizeSm

Class name applied to the root element if size="sm".

.MuiSlider-trackFalse

Class name applied to the root element if track={false}.

.MuiSlider-trackInverted

Class name applied to the root element if track="inverted".

.MuiSlider-valueLabelOpen

Class name applied to the thumb label element if it's open.

.MuiSlider-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiSlider-variantPlain

Class name applied to the root element if variant="plain".

.MuiSlider-variantSoft

Class name applied to the root element if variant="soft".

.MuiSlider-variantSolid

Class name applied to the root element if variant="solid".

.MuiSlider-vertical

Class name applied to the root element if orientation="vertical".

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.