StepLabel API
API documentation for the React StepLabel component. Learn about the available props, and the CSS API.
Import
import StepLabel from '@material-ui/core/StepLabel';
// 或
import { StepLabel } from '@material-ui/core';
Component name
The nameMuiStepLabel
can be used when providing default props or style overrides in the theme.属性
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
children | node | In most cases will simply be a string containing a title for the label. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
error | bool | false | Mark the step as failed. |
icon | node | Override the default label of the step icon. | |
optional | node | The optional node to display. | |
StepIconComponent | elementType | The component to render in place of the StepIcon . | |
StepIconProps | object | Props applied to the StepIcon element. | |
sx | object |
ref
则会被传递到根元素中。Any other props supplied will be provided to the root element (native element).
CSS
Rule name | Global class | 描述 |
---|---|---|
root | .MuiStepLabel-root | Styles applied to the root element. |
horizontal | .MuiStepLabel-horizontal | Styles applied to the root element if orientation="horizontal" . |
vertical | .MuiStepLabel-vertical | Styles applied to the root element if orientation="vertical" . |
label | .MuiStepLabel-label | Styles applied to the Typography component that wraps `children`. |
active | .MuiStepLabel-active | Pseudo-class applied to the `Typography` component if active={true} . |
completed | .MuiStepLabel-completed | Pseudo-class applied to the `Typography` component if completed={true} . |
error | .Mui-error | Pseudo-class applied to the root element and `Typography` component if error={true} . |
disabled | .Mui-disabled | Pseudo-class applied to the root element and `Typography` component if disabled={true} . |
iconContainer | .MuiStepLabel-iconContainer | Styles applied to the `icon` container element. |
alternativeLabel | .MuiStepLabel-alternativeLabel | Pseudo-class applied to the root and icon container and `Typography` if alternativeLabel={true} . |
labelContainer | .MuiStepLabel-labelContainer | Styles applied to the container element which wraps `Typography` and `optional`. |
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.