ant-design/components/steps/index.zh-CN.md

54 lines
2.2 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
2016-09-21 11:28:38 +08:00
subtitle: 步骤条
type: 导航
2016-03-31 14:17:09 +08:00
cols: 1
2016-09-21 11:28:38 +08:00
title: Steps
2016-03-31 14:17:09 +08:00
---
2015-06-15 22:01:39 +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
| 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- |
| className | 步骤条类名 | string | - | 3.11.3 |
| type | 步骤条类型,有 `default``navigation` 两种 | string | `default` | 3.22.0 |
| current | 指定当前步骤,从 0 开始记数。在子 Step 元素中,可以通过 `status` 属性覆盖状态 | number | 0 | |
| direction | 指定步骤条方向。目前支持水平(`horizontal`)和竖直(`vertical`)两种方向 | string | horizontal | |
| labelPlacement | 指定标签放置位置,默认水平放图标右侧,可选 `vertical` 放图标下方 | string | `horizontal` | 3.7.3 |
| progressDot | 点状步骤条,可以设置为一个 functionlabelPlacement 将强制为 `vertical` | Boolean or (iconDot, {index, status, title, description}) => ReactNode | false | |
| size | 指定大小,目前支持普通(`default`)和迷你(`small` | string | default | |
| status | 指定当前步骤的状态,可选 `wait` `process` `finish` `error` | string | process | |
| initial | 起始序号,从 0 开始记数 | number | 0 | 3.9.0 |
| onChange | 点击切换步骤时触发 | (current) => void | - | 3.19.0 |
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
| 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- |
| description | 步骤的详情描述,可选 | string\|ReactNode | - | |
| icon | 步骤图标的类型,可选 | string\|ReactNode | - | |
| status | 指定状态。当不配置该属性时,会使用 Steps 的 `current` 来自动指定状态。可选:`wait` `process` `finish` `error` | string | wait | |
| title | 标题 | string\|ReactNode | - | |
| subTitle | 子标题 | string\|ReactNode | - | 3.22.0 |
| disabled | 禁用点击 | boolean | false | 3.22.0 |