Skip to content

MobileStepper API

API documentation for the React MobileStepper component. Learn about the available props, and the CSS API.

Import

import MobileStepper from '@material-ui/core/MobileStepper';
// or
import { MobileStepper } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiMobileStepper can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
activeStepnumber0Set the active step (zero based index). Defines which dot is highlighted when the variant is 'dots'.
backButtonnodeA back button element. For instance, it can be a Button or an IconButton.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
LinearProgressPropsobjectProps applied to the LinearProgress element.
nextButtonnodeA next button element. For instance, it can be a Button or an IconButton.
position'bottom'
| 'static'
| 'top'
'bottom'Set the positioning type.
steps*numberThe total steps.
variant'dots'
| 'progress'
| 'text'
'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).

Inheritance

While not explicitly documented above, the props of the Paper component are also available on MobileStepper. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiMobileStepper-rootStyles applied to the root element.
positionBottom.MuiMobileStepper-positionBottomStyles applied to the root element if position="bottom".
positionTop.MuiMobileStepper-positionTopStyles applied to the root element if position="top".
positionStatic.MuiMobileStepper-positionStaticStyles applied to the root element if position="static".
dots.MuiMobileStepper-dotsStyles applied to the dots container if variant="dots".
dot.MuiMobileStepper-dotStyles applied to each dot if variant="dots".
dotActive.MuiMobileStepper-dotActiveStyles applied to a dot if variant="dots" and this is the active step.
progress.MuiMobileStepper-progressStyles applied to the Linear Progress component if variant="progress".

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos