ant-design/components/steps/index.md

47 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>
2016-03-04 11:46:24 +08:00
<Step title="第一步" />
<Step title="第二步" />
<Step title="第三步" />
2015-07-16 18:26:17 +08:00
</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
2016-04-06 16:16:36 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|-----------|------------------------------------------|-------------|-------|
| current | 指定当前步骤,从 0 开始记数。在子 Step 元素中,可以通过 `status` 属性覆盖状态 | number | 0 |
| size | 指定大小,目前支持普通(`default`)和迷你(`small`| string | default |
| direction | 指定步骤条方向。目前支持水平和竖直(`vertical`)两种方向,默认水平方向) | string | - |
| maxDescriptionWidth | 指定步骤的详细描述文字的最大宽度(单位 px | number | 100 |
2015-06-25 19:32:06 +08:00
### Steps.Step
2016-04-06 16:16:36 +08:00
步骤条内的每一个步骤。
2015-06-25 19:32:06 +08:00
2016-04-06 16:16:36 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|----------|-----------------------------------------|------------|-------|
| status | 指定状态。当不配置该属性时,会使用 Steps 的 `current` 来自动指定状态。可选:`wait` `process` `finish` | string | `wait` |
| title | 标题 | React.Element | - |
| description | 步骤的详情描述,可选 | React.Element | - |
| icon | 步骤图标,可选 | React.Element | - |