mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-27 18:50:59 +08:00
1.5 KiB
1.5 KiB
| category | type | cols | title |
|---|---|---|---|
| Components | Navigation | 1 | Steps |
Steps is a navigation bar that guides users through the steps of a task.
When to use
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
<Steps>
<Step title="first step" />
<Step title="second step" />
<Step title="third step" />
</Steps>
Steps
The whole of the step bar.
| Property | Description | Type | Default |
|---|---|---|---|
| current | to set the current step, counting from 0. You can overwrite this state by using status of Step |
Number | 0 |
| status | to specify the status of current step, can be set to one of the following values: wait process finish error |
String | process |
| size | to specify the size of the step bar, default and small are currently supported |
String | default |
| direction | to specify the direction of the step bar, horizontal and vertical are currently supported |
String | horizontal |
Steps.Step
A single step in the step bar.
| Property | Description | Type | Default |
|---|---|---|---|
| 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 | React.Element | - |
| description | detail of the step, optional property | React.Element | - |
| icon | icon of the step, optional property | React.Element | - |