跳转到内容

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.
activeStepinteger0
Set the active step (zero based index). Defines which dot is highlighted when the variant is 'dots'.
backButtonnode
A back button element. For instance, it can be a Button or an IconButton.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
LinearProgressPropsobject
Props applied to the LinearProgress element.
nextButtonnode
A next button element. For instance, it can be a Button or an IconButton.
position'bottom'
| 'static'
| 'top'
'bottom'
Set the positioning type.
sxArray<func
| object>
| 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 nameGlobal class描述
root.MuiMobileStepper-rootStyles applied to the root element.
positionBottom.MuiMobileStepper-positionBottomStyles applied to the root element if position="bottom".
positionTop.MuiMobileStepper-positionTopStyles applied to the root element if position="top".
positionStatic.MuiMobileStepper-positionStaticStyles applied to the root element if position="static".
dots.MuiMobileStepper-dotsStyles applied to the dots container if variant="dots".
dot.MuiMobileStepper-dotStyles applied to each dot if variant="dots".
dotActive.MuiMobileStepper-dotActiveStyles applied to a dot if variant="dots" and this is the active step.
progress.MuiMobileStepper-progressStyles applied to the Linear Progress component if variant="progress".

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

Demos