Skip to content

Stepper API

The API documentation of the Stepper React component. Learn more about the properties and the CSS customization points.

import Stepper from '@material-ui/core/Stepper';

Props

Name Type Default Description
activeStep number 0 Set the active step (zero based index).
alternativeLabel bool false If set to 'true' and orientation is horizontal, then the step label will be positioned under the icon.
children * node Two or more <Step /> components.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
connector element <StepConnector /> An element to be placed between each step.
nonLinear bool false If set the Stepper will not assist in controlling steps for linear flow.
orientation enum: 'horizontal' |
 'vertical'
'horizontal' The stepper orientation (layout flow direction).

The ref is forwarded to the root element.

Any other properties supplied will be provided to the root element (Paper).

CSS

You can override all the class names injected by Material-UI thanks to the classes property. This property accepts the following keys:

Name Description
root Styles applied to the root element.
horizontal Styles applied to the root element if orientation="horizontal".
vertical Styles applied to the root element if orientation="vertical".
alternativeLabel Styles applied to the root element if alternativeLabel={true}.

Have a look at the overriding styles with classes section and the implementation of the component for more detail.

If using the overrides key of the theme, you need to use the following style sheet name: MuiStepper.

Inheritance

The properties of the Paper component are also available. You can take advantage of this behavior to target nested components.

Notes

The component can cause issues in StrictMode.

Demos