MobileStepper API

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

Component demos

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

Stepper

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'

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 classes

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

.MuiMobileStepper-dot

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

Rule name:dot

.MuiMobileStepper-dotActive

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

Rule name:dotActive

.MuiMobileStepper-dots

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

Rule name:dots

.MuiMobileStepper-positionBottom

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

Rule name:positionBottom

.MuiMobileStepper-positionStatic

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

Rule name:positionStatic

.MuiMobileStepper-positionTop

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

Rule name:positionTop

.MuiMobileStepper-progress

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

Rule name:progress

.MuiMobileStepper-root

Styles applied to the root element.

Rule name:root

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.