Skip to content

MobileStepper API

API reference docs for the React MobileStepper component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import MobileStepper from '@mui/material/MobileStepper';
// or
import { MobileStepper } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the Paper component are also available.

NameTypeDefaultDescription
steps*integer-

The total steps.

activeStepinteger0

Set the active step (zero based index). Defines which dot is highlighted when the variant is 'dots'.

backButtonnode-

A back button element. For instance, it can be a Button or an IconButton.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

LinearProgressPropsobject-

Props applied to the LinearProgress element.

nextButtonnode-

A next button element. For instance, it can be a Button or an IconButton.

position'bottom'
| 'static'
| 'top'
'bottom'

Set the positioning type.

sxArray<func
| object
| bool>
| func
| object
-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

variant'dots'
| 'progress'
| 'text'
'dots'

The variant to use.

The ref is forwarded to the root element.

Inheritance

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

Theme default props

You can use MuiMobileStepper to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiMobileStepper-dotdotStyles applied to each dot if variant="dots".
.MuiMobileStepper-dotActivedotActiveStyles applied to a dot if variant="dots" and this is the active step.
.MuiMobileStepper-dotsdotsStyles applied to the dots container if variant="dots".
.MuiMobileStepper-positionBottompositionBottomStyles applied to the root element if position="bottom".
.MuiMobileStepper-positionStaticpositionStaticStyles applied to the root element if position="static".
.MuiMobileStepper-positionToppositionTopStyles applied to the root element if position="top".
.MuiMobileStepper-progressprogressStyles applied to the Linear Progress component if variant="progress".
.MuiMobileStepper-rootrootStyles applied to the root element.

You can override the style of the component using one of these customization options:

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.