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 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. |
| 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. |
| 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 ref is forwarded to the root element.
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.
You can use MuiMobileStepper to change the default props of this component with the theme.
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-dot | dot | Styles applied to each dot if variant="dots". |
| .MuiMobileStepper-dotActive | dotActive | Styles applied to a dot if variant="dots" and this is the active step. |
| .MuiMobileStepper-dots | dots | Styles applied to the dots container if variant="dots". |
| .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". |
| .MuiMobileStepper-progress | progress | Styles applied to the Linear Progress component if variant="progress". |
| .MuiMobileStepper-root | root | Styles applied to the root element. |
You can override the style of the component using one of these customization options:
styleOverrides property in a custom theme.If you did not find the information in this page, consider having a look at the implementation of the component for more detail.