mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-28 11:08:30 +08:00
88 lines
4.6 KiB
Markdown
88 lines
4.6 KiB
Markdown
---
|
||
category: Components
|
||
group: Navigation
|
||
title: Steps
|
||
description: A navigation bar that guides users through the steps of a task.
|
||
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*677sTqCpE3wAAAAAAAAAAAAADrJ8AQ/original
|
||
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*cFsBQLA0b7UAAAAAAAAAAAAADrJ8AQ/original
|
||
---
|
||
|
||
## When To Use
|
||
|
||
When a given task is complicated or has a certain sequence in the series of subtasks, we can decompose it into several steps to make things easier.
|
||
|
||
## Examples
|
||
|
||
<!-- prettier-ignore -->
|
||
<code src="./demo/simple.tsx">Basic</code>
|
||
<code src="./demo/small-size.tsx">Mini version</code>
|
||
<code src="./demo/icon.tsx">With icon</code>
|
||
<code src="./demo/step-next.tsx">Switch Step</code>
|
||
<code src="./demo/vertical.tsx">Vertical</code>
|
||
<code src="./demo/vertical-small.tsx">Vertical mini version</code>
|
||
<code src="./demo/error.tsx">Error status</code>
|
||
<code src="./demo/progress-dot.tsx">Dot Style</code>
|
||
<code src="./demo/customized-progress-dot.tsx">Customized Dot Style</code>
|
||
<code src="./demo/progress-dot-small.tsx" debug>Dot Style Size Small</code>
|
||
<code src="./demo/clickable.tsx">Clickable</code>
|
||
<code src="./demo/nav.tsx">Navigation Steps</code>
|
||
<code src="./demo/progress.tsx">Steps with progress</code>
|
||
<code src="./demo/label-placement.tsx">Label Placement</code>
|
||
<code src="./demo/progress-debug.tsx" debug>Progress Debug</code>
|
||
<code src="./demo/steps-in-steps.tsx" debug>Steps inside Steps</code>
|
||
<code src="./demo/inline.tsx">Inline Steps</code>
|
||
<code src="./demo/wireframe.tsx" debug>Wireframe</code>
|
||
<code src="./demo/component-token.tsx" debug>Component Token</code>
|
||
|
||
## API
|
||
|
||
Common props ref：[Common props](/docs/react/common-props)
|
||
|
||
### Steps
|
||
|
||
The whole of the step bar.
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| className | Additional class to Steps | string | - | |
|
||
| current | To set the current step, counting from 0. You can overwrite this state by using `status` of `Step` | number | 0 | |
|
||
| direction | To specify the direction of the step bar, `horizontal` or `vertical` | string | `horizontal` | |
|
||
| initial | Set the initial step, counting from 0 | number | 0 | |
|
||
| labelPlacement | Place title and description with `horizontal` or `vertical` direction | string | `horizontal` | |
|
||
| percent | Progress circle percentage of current step in `process` status (only works on basic Steps) | number | - | 4.5.0 |
|
||
| progressDot | Steps with progress dot style, customize the progress dot by setting it to a function. labelPlacement will be `vertical` | boolean \| (iconDot, {index, status, title, description}) => ReactNode | false | |
|
||
| responsive | Change to vertical direction when screen width smaller than `532px` | boolean | true | |
|
||
| 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` | |
|
||
| type | Type of steps, can be set to one of the following values: `default` `navigation` `inline` | string | `default` | inline: 5.0 |
|
||
| onChange | Trigger when Step is changed | (current) => void | - | |
|
||
| items | StepItem content | [StepItem](#stepitem) | [] | 4.24.0 |
|
||
|
||
### `type="inline"`
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| className | Additional class to Steps | string | - | |
|
||
| current | To set the current step, counting from 0. You can overwrite this state by using `status` of `Step` | number | 0 | |
|
||
| initial | Set the initial step, counting from 0 | 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` | |
|
||
| onChange | Trigger when Step is changed | (current) => void | - | |
|
||
| items | StepItem content. not supported: `icon` `subtitle` | [StepItem](#stepitem) | [] | 4.24.0 |
|
||
|
||
### StepItem
|
||
|
||
A single step in the step bar.
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| description | Description of the step, optional property | ReactNode | - | |
|
||
| disabled | Disable click | boolean | false | |
|
||
| icon | Icon of the step, optional property | 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` | |
|
||
| subTitle | Subtitle of the step | ReactNode | - | |
|
||
| title | Title of the step | ReactNode | - | |
|
||
|
||
## Design Token
|
||
|
||
<ComponentTokenTable component="Steps"></ComponentTokenTable>
|