Skip to content
Edit this page

Stepper API

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

Import

import Stepper from '@material-ui/core/Stepper';
// or
import { Stepper } from '@material-ui/core';

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

Props

Name Type Default Description
activeStep number 0 Set the active step (zero based index). Set to -1 to disable all the steps.
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 'horizontal'
| 'vertical'		 'horizontal' The stepper orientation (layout flow direction).

The ref is forwarded to the root element.

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

CSS

  • Style sheet name: MuiStepper.
  • Style sheet details:
Rule name Global class Description
root .MuiStepper-root Styles applied to the root element.
horizontal .MuiStepper-horizontal Styles applied to the root element if orientation="horizontal".
vertical .MuiStepper-vertical Styles applied to the root element if orientation="vertical".
alternativeLabel .MuiStepper-alternativeLabel Styles applied to the root element if alternativeLabel={true}.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

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

Demos