MobileStepper API
API documentation for the React MobileStepper component. Learn about the available props, and the CSS API.
Import
import MobileStepper from '@material-ui/core/MobileStepper';
// or
import { MobileStepper } from '@material-ui/core';Component name
The nameMuiMobileStepper can be used when providing default props or style overrides in the theme.Props
| Name | Type | Default | Description |
|---|---|---|---|
| steps* | number | The total steps. | |
| activeStep | number | 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 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. |
| variant | 'dots' | 'progress' | 'text' | 'dots' | The variant to use. |
The
ref is forwarded to the root element.Any other props supplied will be provided to the root element (Paper).
Inheritance
While not explicitly documented above, the props of the Paper component are also available on MobileStepper. You can take advantage of this to target nested components.CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiMobileStepper-root | Styles applied to the root element. |
| positionBottom | .MuiMobileStepper-positionBottom | Styles applied to the root element if position="bottom". |
| positionTop | .MuiMobileStepper-positionTop | Styles applied to the root element if position="top". |
| positionStatic | .MuiMobileStepper-positionStatic | Styles applied to the root element if position="static". |
| dots | .MuiMobileStepper-dots | Styles applied to the dots container if variant="dots". |
| dot | .MuiMobileStepper-dot | Styles applied to each dot if variant="dots". |
| dotActive | .MuiMobileStepper-dotActive | Styles applied to a dot if variant="dots" and this is the active step. |
| progress | .MuiMobileStepper-progress | Styles applied to the Linear Progress component if variant="progress". |
You can override the style of the component using one of these customization options:
- With a rule name of the
classesobject prop. - With a global class name.
- With a theme and an
styleOverridesproperty.