Skip to content
Edit this page

MobileStepper API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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.

stepsRequired

The total steps.

Type:

integer
activeStep

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

Type:

integer

Default:

0
backButton

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

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
LinearProgressProps

Props applied to the LinearProgress element.

Type:

object
nextButton

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

Type:

node
position

Set the positioning type.

Type:

'bottom' | 'static' | 'top'

Default:

'bottom'
sx

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

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
variant

The variant to use.

Type:

'dots' | 'progress' | 'text'

Default:

'dots'
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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiMobileStepper-rootroot

Styles applied to the root element.

.MuiMobileStepper-positionBottompositionBottom

Styles applied to the root element if position="bottom".

.MuiMobileStepper-positionToppositionTop

Styles applied to the root element if position="top".

.MuiMobileStepper-positionStaticpositionStatic

Styles applied to the root element if position="static".

.MuiMobileStepper-dotsdots

Styles applied to the dots container if variant="dots".

.MuiMobileStepper-dotdot

Styles applied to each dot if variant="dots".

.MuiMobileStepper-dotActivedotActive

Styles applied to a dot if variant="dots" and this is the active step.

.MuiMobileStepper-progressprogress

Styles applied to the Linear Progress component if variant="progress".

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