MobileStepper API

API documentation for the React MobileStepper component. Learn about the available props, and the CSS API.

Import

import MobileStepper from '@mui/material/MobileStepper';
// 或
import { MobileStepper } from '@mui/material';

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiMobileStepper can be used when providing default props or style overrides in the theme.

属性

Props of the Paper component are also available.

名称	类型	默认值	描述
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 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	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.

ref 则会被传递到根元素中。

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	描述
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 global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Demos

Steppers