2016-07-21 10:07:30 +08:00
---
category: Components
type: Navigation
cols: 1
title: Steps
---
2017-01-23 16:04:05 +08:00
`Steps` is a navigation bar that guides users through the steps of a task.
2016-07-21 10:07:30 +08:00
2016-09-10 13:43:30 +08:00
## When To Use
2016-07-21 10:07:30 +08:00
When the task is complicated or has a certain sequence in the series of subtasks, we can decompose it into several steps to make things easier.
## API
```jsx
< Steps >
< Step title = "first step" / >
< Step title = "second step" / >
< Step title = "third step" / >
< / Steps >
```
### Steps
The whole of the step bar.
2017-10-25 10:25:44 +08:00
| Property | Description | Type | Default |
2019-05-07 14:57:32 +08:00
| --- | --- | --- | --- |
2018-12-12 17:13:39 +08:00
| className | additional class to Steps | string | - |
2017-10-25 10:25:44 +08:00
| current | to set the current step, counting from 0. You can overwrite this state by using `status` of `Step` | number | 0 |
2018-11-05 18:32:05 +08:00
| direction | to specify the direction of the step bar, `horizontal` or `vertical` | string | `horizontal` |
| labelPlacement | place title and description with `horizontal` or `vertical` direction | string | `horizontal` |
2018-07-24 11:26:14 +08:00
| progressDot | Steps with progress dot style, customize the progress dot by setting it to a function. labelPlacement will be `vertical` | Boolean or (iconDot, {index, status, title, description}) => ReactNode | false |
2017-10-25 10:25:44 +08:00
| size | to specify the size of the step bar, `default` and `small` are currently supported | string | `default` |
| status | to specify the status of current step, can be set to one of the following values: `wait` `process` `finish` `error` | string | `process` |
2018-08-22 13:53:57 +08:00
| initial | set the initial step, counting from 0 | number | 0 |
2016-07-21 10:07:30 +08:00
### Steps.Step
A single step in the step bar.
2017-10-25 10:25:44 +08:00
| Property | Description | Type | Default |
2019-05-07 14:57:32 +08:00
| --- | --- | --- | --- |
2017-10-25 10:25:44 +08:00
| description | description of the step, optional property | string\|ReactNode | - |
| icon | icon of the step, optional property | string\|ReactNode | - |
| status | to specify the status. It will be automatically set by `current` of `Steps` if not configured. Optional values are: `wait` `process` `finish` `error` | string | `wait` |
| title | title of the step | string\|ReactNode | - |
