Skip to content
Edit this page

MobileStepper API

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

Import

import MobileStepper from '@material-ui/core/MobileStepper';
// or
import { MobileStepper } 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). Defines which dot is highlighted when the variant is 'dots'.
backButton node A back button element. For instance, it can be a Button or an IconButton.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
LinearProgressProps object Props applied to the LinearProgress element.
nextButton node A next button element. For instance, it can be a Button or an IconButton.
position 'bottom'
| 'top'
| 'static'		 'bottom' Set the positioning type.
steps * number The total steps.
variant 'text'
| 'dots'
| 'progress'		 'dots' The variant to use.

The ref is forwarded to the root element.

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

CSS

  • Style sheet name: MuiMobileStepper.
  • Style sheet details:
Rule name Global class Description
root .MuiMobileStepper-root Styles applied to the root element.
positionBottom .MuiMobileStepper-positionBottom Styles applied to the root element if position="bottom".
positionTop .MuiMobileStepper-positionTop Styles applied to the root element if position="top".
positionStatic .MuiMobileStepper-positionStatic Styles applied to the root element if position="static".
dots .MuiMobileStepper-dots Styles applied to the dots container if variant="dots".
dot .MuiMobileStepper-dot Styles applied to each dot if variant="dots".
dotActive .MuiMobileStepper-dotActive Styles applied to a dot if variant="dots" and this is the active step.
progress .MuiMobileStepper-progress Styles applied to the Linear Progress component if variant="progress".

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