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:

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.

Name	Type	Default	Description
steps*	integer	-	The total steps.
activeStep	integer	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 classes API below for more details.
LinearProgressProps	object	-	Props applied to the `LinearProgress` element. Deprecated－Use `slotProps.progress` instead. This prop will be removed in v7. See Migrating from deprecated APIs for more details.
nextButton	node	-	A next button element. For instance, it can be a `Button` or an `IconButton`.
position	'bottom' \| 'static' \| 'top'	'bottom'	Set the positioning type.
slotProps	{ dot?: func \| object, dots?: func \| object, progress?: func \| object, root?: func \| object }	{}	The props used for each slot inside.
slots	{ dot?: elementType, dots?: elementType, progress?: elementType, root?: elementType }	{}	The components used for each slot inside.
sx	Array<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 component cannot hold a ref.

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.

Slots

Slot name	Class name	Default component	Description
root	.MuiMobileStepper-root	`Paper`	The component that renders the root slot.
progress	.MuiMobileStepper-progress	`LinearProgress`	The component that renders the progress slot.
dots	.MuiMobileStepper-dots	`'div'`	The component that renders the dots slot.
dot	.MuiMobileStepper-dot	`'div'`	The component that renders the dot slot.

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 name	Rule name	Description
.MuiMobileStepper-dotActive	dotActive	Styles applied to a dot if `variant="dots"` and this is the active step.
.MuiMobileStepper-positionBottom	positionBottom	Styles applied to the root element if `position="bottom"`.
.MuiMobileStepper-positionStatic	positionStatic	Styles applied to the root element if `position="static"`.
.MuiMobileStepper-positionTop	positionTop	Styles applied to the root element if `position="top"`.

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.

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.