Skip to content

Stepper API

API documentation for the React Stepper component. Learn about the available props, and the CSS API.


import Stepper from '@material-ui/core/Stepper';
// or
import { Stepper } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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


activeStepnumber0Set the active step (zero based index). Set to -1 to disable all the steps.
alternativeLabelboolfalseIf set to 'true' and orientation is horizontal, then the step label will be positioned under the icon.
childrennodeTwo or more <Step /> components.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
connectorelement<StepConnector />An element to be placed between each step.
nonLinearboolfalseIf set the Stepper will not assist in controlling steps for linear flow.
| 'vertical'
'horizontal'The component orientation (layout flow direction).

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).


Rule nameGlobal classDescription
root.MuiStepper-rootStyles applied to the root element.
horizontal.MuiStepper-horizontalStyles applied to the root element if orientation="horizontal".
vertical.MuiStepper-verticalStyles applied to the root element if orientation="vertical".
alternativeLabel.MuiStepper-alternativeLabelStyles applied to the root element if alternativeLabel={true}.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.