mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-16 09:39:10 +08:00
47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
# Steps
|
||
|
||
- category: Components
|
||
- chinese: 步骤条
|
||
- type: 导航
|
||
- cols: 1
|
||
|
||
---
|
||
|
||
引导用户按照流程完成任务的导航条。
|
||
|
||
## 何时使用
|
||
|
||
当任务复杂或者存在先后关系时，将其分解成一系列步骤，从而简化任务。
|
||
|
||
## API
|
||
|
||
```jsx
|
||
<Steps>
|
||
<Steps.Step title="第一步"></Steps.Step>
|
||
<Steps.Step title="第二步"></Steps.Step>
|
||
<Steps.Step title="第三步"></Steps.Step>
|
||
</Steps>
|
||
```
|
||
|
||
### Steps
|
||
|
||
整体步骤条。
|
||
|
||
| 参数 | 说明 | 类型 | 可选值 |默认值 |
|
||
|-----------|------------------------------------------|------------|-------|--------|
|
||
| current | 可选参数，指定当前处理正在执行状态的步骤，从0开始记数。在子Step元素中，可以通过status属性覆盖状态。 | number | 无 | 0 |
|
||
| size | 可选参数，指定大小（目前只支持普通和迷你两种大小）。 | string | small, default | default |
|
||
| direction | 可选参数，指定步骤条方向（目前支持水平和竖直两种方向，默认水平方向）。 | string | vertical | 无 |
|
||
| maxDescriptionWidth | 可选参数，指定步骤的详细描述文字的最大宽度。 | number | 无 | 100 |
|
||
|
||
### Steps.Step
|
||
|
||
步骤条内的每一个步。
|
||
|
||
| 参数 | 说明 | 类型 | 可选值 |默认值 |
|
||
|-----------|------------------------------------------|------------|-------|--------|
|
||
| status | 可选参数，指定状态。当不配置该属性时，会使用父Steps元素的current来自动指定状态。 | string | wait, process, finish | wait |
|
||
| title | 必要参数，标题。 | string/jsx | 无 | 无 |
|
||
| description | 可选参数，步骤的详情描述。 | string/jsx | 无 | 空 |
|
||
| icon | 可选参数，步骤的Icon。如果不指定，则使用默认的样式。 | string/jsx | 无 | 空 |
|