Stepper

Stepper

The API documentation of the Stepper React component.

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 /> A component 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).

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

CSS API

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 overriding with classes section and the implementation of the component for more detail.

If using the overrides key of the theme as documented here, 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.

Demos