mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-25 19:50:05 +08:00
Code Issues Actions 22 Packages Projects Releases Wiki Activity
060b7ded20
ant-design/components/steps/index.en-US.md
Aaron Cawte 2b46a232db Navigation components doc tweaks (#19447) 
* Documentation - Affix Component

* Documentation - Dropdown component

* Documentation - Menu component

* Documentation - Pagination component

* Documentation - PageHeader component

* Documentation - Steps component
2019-10-28 09:09:22 +08:00

2.4 KiB
Raw Blame History

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 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.

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 Version
className Additional class to Steps string - 3.11.3
type Type of steps, can be set to one of the following values: default, navigation string default 3.22.0
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
labelPlacement Place title and description with horizontal or vertical direction string horizontal 3.7.3
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
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
initial Set the initial step, counting from 0 number 0 3.9.0
onChange Trigger when Step is changed (current) => void - 3.19.0

Steps.Step

A single step in the step bar.

Property Description Type Default Version
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 -
subTitle Subtitle of the step string|ReactNode - 3.22.0
disabled Disable click boolean false 3.22.0