mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2025-01-20 16:03:32 +08:00
Code Issues Actions 21 Packages Projects Releases Wiki Activity
e5a735e888
ant-design/components/steps/index.en-US.md
Wei Zhu 77b78a9389 docs: Unify type naming (#4636) 
* Unify name of ReactNode type in document

* Lowser all string type name

* Lowercase all number type name

* Lowercase all boolean type name

* Unify array type

* Lowercase all object type name

* Unify mutilple types
2017-01-20 20:10:50 +08:00

1.5 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 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 string|ReactNode -
description detail of the step, optional property string|ReactNode -
icon icon of the step, optional property string|ReactNode -