ant-design/components/steps/index.en-US.md
Khalifa Lame f48cf1df90 docs: update Steps English doc (#7463)
Added code tags to string values.
2017-09-05 16:50:27 +08:00

46 lines
1.7 KiB
Markdown

---
category: Components
type: Navigation
cols: 1
title: 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
```jsx
<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`
progressDot | Steps with progress dot style, customize the progress dot by setting it to a function | Boolean or (iconDot, {index, status, title, description}) => ReactNode | false
### 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 | string\|ReactNode | -
description | description of the step, optional property | string\|ReactNode | -
icon | icon of the step, optional property | string\|ReactNode | -