ant-design/components/steps/index.en-US.md
二货爱吃白萝卜 ff614114c0
refactor: Rename Steps labelPlacement to titlePlacement (#53873)
* refactor: labelPlacement

* test: update snapshot
2025-05-20 18:00:38 +08:00

4.5 KiB
Raw Permalink Blame History

category group title description cover coverDark
Components Navigation Steps A navigation bar that guides users through the steps of a task. https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*677sTqCpE3wAAAAAAAAAAAAADrJ8AQ/original 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

Basic Error status Vertical Clickable Panel Steps With icon Switch Step Title Placement and Progress Dot Style Customized Dot Style Navigation Steps Steps with progress Progress Debug Steps inside Steps Inline Steps Inline Style Combination Variant Debug Component Token

API

Common props refCommon props

Steps

The whole of the step bar.

Property Description Type Default Version
classNames Semantic DOM class Record<SemanticDOM, 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
iconRender Custom render icon, please use items.icon first (oriNode, info: { index, active, item }) => ReactNode -
initial Set the initial step, counting from 0 number 0
labelPlacement Place title and content with horizontal or vertical direction string horizontal
orientation To specify the orientation of the step bar, horizontal or vertical 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. titlePlacement will be vertical boolean | (iconDot, { index, status, title, content }) => 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
styles Semantic DOM style Record<SemanticDOM, CSSProperties> -
titlePlacement Place title and content with horizontal or vertical direction string horizontal
type Type of steps, can be set to one of the following values: default dot inline navigation panel string default
onChange Trigger when Step is changed (current) => void -
items StepItem content StepItem [] 4.24.0

StepItem

A single step in the step bar.

Property Description Type Default Version
content Description of the step, optional property ReactNode -
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 -

Semantic DOM

Design Token