Slider API
Demos
For examples and details on the usage of this React component, visit the component demo pages:
Import
import Slider from '@mui/material/Slider';
// or
import { Slider } from '@mui/material';Props
Props of the native component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| aria-label | string | The label of the slider. | |
| aria-labelledby | string | The id of the element containing a label for the slider. | |
| aria-valuetext | string | A string value that provides a user-friendly name for the current value of the slider. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| color | 'primary' | 'secondary' | string | 'primary' | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. |
| components | { Input?: elementType, Mark?: elementType, MarkLabel?: elementType, Rail?: elementType, Root?: elementType, Thumb?: elementType, Track?: elementType, ValueLabel?: elementType } | {} | The components used for each slot inside. This prop is an alias for the slots prop. It's recommended to use the slots prop instead. |
| componentsProps | { input?: func | object, mark?: func | object, markLabel?: func | object, rail?: func | object, root?: func | object, thumb?: func | object, track?: func | object, valueLabel?: func | { children?: element, className?: string, open?: bool, style?: object, value?: number, valueLabelDisplay?: 'auto' | 'off' | 'on' } } | {} | The extra props for the slot components. You can override the existing props or add new ones. This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future. |
| defaultValue | Array<number> | number | The default value. Use when the component is not controlled. | |
| disabled | bool | false | If true, the component is disabled. |
| disableSwap | bool | false | If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb. |
| getAriaLabel | func | 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) => stringindex: The thumb label's index to format. | |
| getAriaValueText | func | 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) => stringvalue: The thumb label's value to format. index: The thumb label's index to format. | |
| marks | Array<{ 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. |
| max | number | 100 | The maximum allowed value of the slider. Should not be equal to min. |
| min | number | 0 | The minimum allowed value of the slider. Should not be equal to max. |
| name | string | Name attribute of the hidden input element. | |
| onChange | func | Callback function that is fired when the slider's value changed. Signature: function(event: Event, value: number | Array<number>, activeThumb: number) => voidevent: 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 | func | Callback function that is fired when the mouseup is triggered.Signature: function(event: React.SyntheticEvent | Event, value: number | Array<number>) => voidevent: 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. |
| scale | func | function Identity(x) { return x; } | A transformation function, to change the scale of the slider. Signature: function(x: any) => any |
| size | 'small' | 'medium' | string | 'medium' | The size of the slider. |
| slotProps | { input?: func | object, mark?: func | object, markLabel?: func | object, rail?: func | object, root?: func | object, thumb?: func | object, track?: func | object, valueLabel?: func | { children?: element, className?: string, open?: bool, style?: object, value?: number, valueLabelDisplay?: 'auto' | 'off' | 'on' } } | {} | The props used for each slot inside the Slider. |
| slots | { input?: elementType, mark?: elementType, markLabel?: elementType, rail?: elementType, root?: elementType, thumb?: elementType, track?: elementType, valueLabel?: elementType } | {} | The components used for each slot inside the Slider. Either a string to use a HTML element or a component. |
| step | number | 1 | 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. |
| sx | Array<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. | |
| tabIndex | number | 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. |
| value | Array<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. |
| valueLabelFormat | func | 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 |
The
ref is forwarded to the root element.Theme default props
You can useMuiSlider to change the default props of this component with the theme.CSS
The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiSlider-root | Styles applied to the root element. |
| colorPrimary | .MuiSlider-colorPrimary | Styles applied to the root element if color="primary". |
| colorSecondary | .MuiSlider-colorSecondary | Styles applied to the root element if color="secondary". |
| marked | .MuiSlider-marked | Styles applied to the root element if marks is provided with at least one label. |
| vertical | .MuiSlider-vertical | Styles applied to the root element if orientation="vertical". |
| disabled STATE | .Mui-disabled | State class applied to the root and thumb element if disabled={true}. |
| dragging | .MuiSlider-dragging | State class applied to the root if a thumb is being dragged. |
| rail | .MuiSlider-rail | Styles applied to the rail element. |
| track | .MuiSlider-track | Styles applied to the track element. |
| trackFalse | .MuiSlider-trackFalse | Styles applied to the root element if track={false}. |
| trackInverted | .MuiSlider-trackInverted | Styles applied to the root element if track="inverted". |
| thumb | .MuiSlider-thumb | Styles applied to the thumb element. |
| active STATE | .Mui-active | State class applied to the thumb element if it's active. |
| focusVisible STATE | .Mui-focusVisible | State class applied to the thumb element if keyboard focused. |
| mark | .MuiSlider-mark | Styles applied to the mark element. |
| markActive | .MuiSlider-markActive | Styles applied to the mark element if active (depending on the value). |
| markLabel | .MuiSlider-markLabel | Styles applied to the mark label element. |
| markLabelActive | .MuiSlider-markLabelActive | Styles applied to the mark label element if active (depending on the value). |
| sizeSmall | .MuiSlider-sizeSmall | Styles applied to the root element if size="small". |
| thumbColorPrimary | .MuiSlider-thumbColorPrimary | Styles applied to the thumb element if color="primary". |
| thumbColorSecondary | .MuiSlider-thumbColorSecondary | Styles applied to the thumb element if color="secondary". |
| thumbSizeSmall | .MuiSlider-thumbSizeSmall | Styles applied to the thumb element if size="small". |
| valueLabel | .MuiSlider-valueLabel | Styles applied to the thumb label element. |
| valueLabelOpen | .MuiSlider-valueLabelOpen | Styles applied to the thumb label element if it's open. |
| valueLabelCircle | .MuiSlider-valueLabelCircle | Styles applied to the thumb label's circle element. |
| valueLabelLabel | .MuiSlider-valueLabelLabel | Styles applied to the thumb label's label element. |
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
styleOverridesproperty in a custom theme.