MobileStepper

MobileStepper

The API documentation of the MobileStepper React component.

Props

Name Type Default Description
activeStep number 0 Set the active step (zero based index). Defines which dot is highlighted when the variant is 'dots'.
backButton node   A back button element. For instance, it can be be a Button or a IconButton.
classes object   Override or extend the styles applied to the component. See CSS API below for more details.
LinearProgressProps object   Properties applied to the LinearProgress element.
nextButton node   A next button element. For instance, it can be be a Button or a IconButton.
position enum: 'bottom' |
 'top' |
 'static'
'bottom' Set the positioning type.
steps * number   The total steps.
variant enum: 'text' |
 'dots' |
 'progress'
'dots' The variant to use.

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.
positionBottom Styles applied to the root element if position="bottom".
positionTop Styles applied to the root element if position="top".
positionStatic Styles applied to the root element if position="static".
dots Styles applied to the dots container if variant="dots".
dot Styles applied to each dot if variant="dots".
dotActive Styles applied to a dot if variant="dots" and this is the active step.
progress Styles applied to the Linear Progress component if variant="progress".

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: MuiMobileStepper.

Inheritance

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

Demos