StepIndicatorAPI
React StepIndicator 组件的 API 参考文档。了解此导出的模块的 props、CSS 和其他 API。
演示
Import
import StepIndicator from '@mui/joy/StepIndicator';
// or
import { StepIndicator } from '@mui/joy';
通过阅读关于最小化 bundle size 的指南,了解它们之间的区别。
原生组件的 Props 也可用。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
children | node | - | 如果未设置 |
color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'neutral' | 组件的颜色。它支持对该组件有意义的主题颜色。 要了解如何添加您自己的颜色,请查看主题组件—扩展颜色。 |
component | elementType | - | 用于根节点的组件。可以是用于 HTML 元素的字符串或组件。 |
slotProps | { root?: func | object } | {} | 用于内部每个 slot 的 props。 |
slots | { root?: elementType } | {} | 用于内部每个 slot 的组件。 有关更多详细信息,请参见下面的Slots API。 |
sx | Array<func | object | bool> | func | object | - | 允许定义系统 overrides 以及其他 CSS 样式的系统 prop。 有关更多详细信息,请参见 `sx` 页面。 |
variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'soft' | 要使用的全局 variant。 要了解如何添加您自己的 variants,请查看主题组件—扩展 variants。 |
ref
被转发到根元素。主题默认 props
您可以使用 JoyStepIndicator
通过主题更改此组件的默认 props。
要了解如何自定义 slot,请查看覆盖组件结构指南。
Slot 名称 | Class 名称 | 默认组件 | 描述 |
---|---|---|---|
root | .MuiStepIndicator-root | 'div' | 渲染 root 的组件。 |
这些 class 名称对于使用 CSS 进行样式设置很有用。当触发特定状态时,它们会应用于组件的 slots。
Class 名称 | 规则名称 | 描述 |
---|---|---|
.MuiStepIndicator-colorContext | colorContext | 当颜色反转被触发时,应用于根元素的 Class 名称。 |
.MuiStepIndicator-colorDanger | colorDanger | 如果 color="danger" ,则应用于根元素的 Class 名称。 |
.MuiStepIndicator-colorNeutral | colorNeutral | 如果 color="neutral" ,则应用于根元素的 Class 名称。 |
.MuiStepIndicator-colorPrimary | colorPrimary | 如果 color="primary" ,则应用于根元素的 Class 名称。 |
.MuiStepIndicator-colorSuccess | colorSuccess | 如果 color="success" ,则应用于根元素的 Class 名称。 |
.MuiStepIndicator-colorWarning | colorWarning | 如果 color="warning" ,则应用于根元素的 Class 名称。 |
.MuiStepIndicator-horizontal | horizontal | 如果 orientation="horizontal" ,则应用于根元素的 Class 名称。 |
.MuiStepIndicator-variantOutlined | variantOutlined | 如果 variant="outlined" ,则应用于根元素的 Class 名称。 |
.MuiStepIndicator-variantPlain | variantPlain | 如果 variant="plain" ,则应用于根元素的 Class 名称。 |
.MuiStepIndicator-variantSoft | variantSoft | 如果 variant="soft" ,则应用于根元素的 Class 名称。 |
.MuiStepIndicator-variantSolid | variantSolid | 如果 variant="solid" ,则应用于根元素的 Class 名称。 |
.MuiStepIndicator-vertical | vertical | 如果 orientation="vertical" ,则应用于根元素的 Class 名称。 |
您可以使用以下自定义选项之一来覆盖组件的样式
- 使用全局 class 名称。
- 在自定义主题中,将规则名称作为组件的
styleOverrides
属性的一部分。
源代码
如果您在此页面中找不到信息,请考虑查看组件的实现以获取更多详细信息。