Skip to content
Edit this page

SliderStyled API

The API documentation of the SliderStyled React component. Learn more about the props and the CSS customization points.

Import

import SliderStyled from '@material-ui/lab/SliderStyled';
// or
import { SliderStyled } from '@material-ui/lab';

You can learn more about the difference by reading this guide.

Props

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.
color 'primary'
| 'secondary'		 The color of the component. It supports those theme colors that make sense for this component.
components { 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.
componentsProps object The props used for each slot inside the Slider.
defaultValue Array<number>
| number		 The default element value. Use when the component is not controlled.
disabled bool If true, the slider will be disabled.
getAriaLabel func Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider.

Signature:
function(index: number) => string
index: 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.

Signature:
function(value: number, index: number) => string
value: The thumb label's value to format.
index: The thumb label's index to format.
isRtl bool Indicates whether the theme context has rtl direction. It is set automatically.
marks Array<{ label?: node, value: number }>
| bool		 Marks indicate predetermined values to which the user can move the slider. If true the marks will be spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.
max number The maximum allowed value of the slider. Should not be equal to min.
min number 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: object, value: number | number[]) => void
event: The event source of the callback. Warning: This is a generic event not a change event.
value: The new value.
onChangeCommitted func Callback function that is fired when the mouseup is triggered.

Signature:
function(event: object, value: number | 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'		 The slider orientation.
scale func A transformation function, to change the scale of the slider.
step number 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.
track 'inverted'
| 'normal'
| false		 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'		 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		 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.

Any other props supplied will be provided to the root element (native element).

Demos