ant-design/components/steps/index.md

46 lines
1.6 KiB
Markdown
Raw Normal View History

2015-06-25 16:01:04 +08:00
# Steps
2015-06-15 22:01:39 +08:00
- category: Components
2015-06-25 20:01:20 +08:00
- chinese: 步骤条
2015-08-22 20:16:24 +08:00
- type: 导航
2015-06-25 18:12:42 +08:00
- cols: 1
2015-06-15 22:01:39 +08:00
---
2015-06-24 14:52:49 +08:00
2015-06-26 14:42:30 +08:00
引导用户按照流程完成任务的导航条。
2015-06-24 14:52:49 +08:00
## 何时使用
2015-06-26 14:42:30 +08:00
当任务复杂或者存在先后关系时,将其分解成一系列步骤,从而简化任务。
2015-06-24 14:52:49 +08:00
## API
2015-07-16 18:26:17 +08:00
```jsx
<Steps>
<Steps.Step title="第一步"></Steps.Step>
<Steps.Step title="第二步"></Steps.Step>
<Steps.Step title="第三步"></Steps.Step>
</Steps>
```
2015-06-25 19:32:06 +08:00
### Steps
2015-07-17 09:42:09 +08:00
整体步骤条。
2015-06-25 19:32:06 +08:00
| 参数 | 说明 | 类型 | 可选值 |默认值 |
|-----------|------------------------------------------|------------|-------|--------|
2015-07-17 09:42:09 +08:00
| size | 可选参数,指定大小(目前只支持普通和迷你两种大小)。 | string | small, default | default |
2015-08-27 14:36:02 +08:00
| direction | 可选参数,指定步骤条方向(目前支持水平和竖直两种方向,默认水平方向)。 | string | vertical | 无 |
2015-07-17 09:42:09 +08:00
| maxDescriptionWidth | 可选参数,指定步骤的详细描述文字的最大宽度。 | number | 无 | 100 |
2015-06-25 19:32:06 +08:00
### Steps.Step
2015-07-17 09:42:09 +08:00
步骤条内的每一个步。
2015-06-25 19:32:06 +08:00
| 参数 | 说明 | 类型 | 可选值 |默认值 |
|-----------|------------------------------------------|------------|-------|--------|
2015-07-17 09:42:09 +08:00
| status | 必要参数,指定状态。 | string | wait, process, finish | 无 |
| title | 必要参数,标题。 | string/jsx | 无 | 无 |
| description | 可选参数,步骤的详情描述。 | string/jsx | 无 | 空 |
2015-06-25 19:32:06 +08:00
| icon | 可选参数步骤的Icon。如果不指定则使用默认的样式。 | string/jsx | 无 | 空 |