2016-03-31 14:17:09 +08:00
|
|
|
|
---
|
|
|
|
|
category: Components
|
2016-09-21 11:28:38 +08:00
|
|
|
|
subtitle: 步骤条
|
2018-11-04 16:20:35 +08:00
|
|
|
|
type: 导航
|
2016-03-31 14:17:09 +08:00
|
|
|
|
cols: 1
|
2016-09-21 11:28:38 +08:00
|
|
|
|
title: Steps
|
2020-05-31 11:48:34 +08:00
|
|
|
|
cover: https://gw.alipayobjects.com/zos/antfincdn/UZYqMizXHaj/Steps.svg
|
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
|
|
|
|
|
2019-05-25 21:01:21 +08:00
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
2019-11-22 10:33:34 +08:00
|
|
|
|
| className | 步骤条类名 | string | - | |
|
2019-05-25 21:01:21 +08:00
|
|
|
|
| current | 指定当前步骤,从 0 开始记数。在子 Step 元素中,可以通过 `status` 属性覆盖状态 | number | 0 | |
|
2020-06-30 15:39:12 +08:00
|
|
|
|
| direction | 指定步骤条方向。目前支持水平(`horizontal`)和竖直(`vertical`)两种方向 | string | `horizontal` | |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| initial | 起始序号,从 0 开始记数 | number | 0 | |
|
2019-11-22 10:33:34 +08:00
|
|
|
|
| labelPlacement | 指定标签放置位置,默认水平放图标右侧,可选 `vertical` 放图标下方 | string | `horizontal` | |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| percent | 当前 `process` 步骤显示的进度条进度(只对基本类型的 Steps 生效) | number | - | 4.5.0 |
|
2020-06-30 15:39:12 +08:00
|
|
|
|
| progressDot | 点状步骤条,可以设置为一个 function,labelPlacement 将强制为 `vertical` | boolean \| (iconDot, {index, status, title, description}) => ReactNode | false | |
|
2020-12-21 17:25:32 +08:00
|
|
|
|
| responsive | 当屏幕宽度小于 532px 时自动变为垂直模式 | boolean | - | true |
|
2020-06-30 15:39:12 +08:00
|
|
|
|
| size | 指定大小,目前支持普通(`default`)和迷你(`small`) | string | `default` | |
|
|
|
|
|
| status | 指定当前步骤的状态,可选 `wait` `process` `finish` `error` | string | `process` | |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| type | 步骤条类型,有 `default` 和 `navigation` 两种 | string | `default` | |
|
2019-11-22 10:33:34 +08:00
|
|
|
|
| onChange | 点击切换步骤时触发 | (current) => void | - | |
|
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
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
2020-10-09 10:08:52 +08:00
|
|
|
|
| description | 步骤的详情描述,可选 | ReactNode | - | |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| disabled | 禁用点击 | boolean | false | |
|
2019-08-13 14:07:17 +08:00
|
|
|
|
| icon | 步骤图标的类型,可选 | ReactNode | - | |
|
2020-06-17 23:18:14 +08:00
|
|
|
|
| status | 指定状态。当不配置该属性时,会使用 Steps 的 `current` 来自动指定状态。可选:`wait` `process` `finish` `error` | string | `wait` | |
|
2020-10-09 10:08:52 +08:00
|
|
|
|
| subTitle | 子标题 | ReactNode | - | |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| title | 标题 | ReactNode | - | |
|