ant-design/components/steps/index.zh-CN.md
Tom Xu d44f404eae
docs: sort api (#27251)
* chore: improve sort api table scripts

* sort api

* add ignore

* Revert "sort api"

This reverts commit 343505d5f09d69349ce1fbdaea2a9faa7e852207.

* sort api

* Update package.json

* sort api

* Delete sort-api.js

* sort api

* sort api

* sort api

* fix

* Update index.zh-CN.md

* fix input-number

* fix input-number

* sort func

* fix

* Method moved to the end

* carousel method
2020-10-21 10:33:43 +08:00

2.3 KiB
Raw Blame History

category subtitle type cols title cover
Components 步骤条 导航 1 Steps https://gw.alipayobjects.com/zos/antfincdn/UZYqMizXHaj/Steps.svg

引导用户按照流程完成任务的导航条。

何时使用

当任务复杂或者存在先后关系时,将其分解成一系列步骤,从而简化任务。

API

<Steps>
  <Step title="第一步" />
  <Step title="第二步" />
  <Step title="第三步" />
</Steps>

Steps

整体步骤条。

参数 说明 类型 默认值 版本
className 步骤条类名 string -
current 指定当前步骤,从 0 开始记数。在子 Step 元素中,可以通过 status 属性覆盖状态 number 0
direction 指定步骤条方向。目前支持水平(horizontal)和竖直(vertical)两种方向 string horizontal
initial 起始序号,从 0 开始记数 number 0
labelPlacement 指定标签放置位置,默认水平放图标右侧,可选 vertical 放图标下方 string horizontal
percent 当前 process 步骤显示的进度条进度(只对基本类型的 Steps 生效) number - 4.5.0
progressDot 点状步骤条,可以设置为一个 functionlabelPlacement 将强制为 vertical boolean | (iconDot, {index, status, title, description}) => ReactNode false
size 指定大小,目前支持普通(default)和迷你(small string default
status 指定当前步骤的状态,可选 wait process finish error string process
type 步骤条类型,有 defaultnavigation 两种 string default
onChange 点击切换步骤时触发 (current) => void -

Steps.Step

步骤条内的每一个步骤。

参数 说明 类型 默认值 版本
description 步骤的详情描述,可选 ReactNode -
disabled 禁用点击 boolean false
icon 步骤图标的类型,可选 ReactNode -
status 指定状态。当不配置该属性时,会使用 Steps 的 current 来自动指定状态。可选:wait process finish error string wait
subTitle 子标题 ReactNode -
title 标题 ReactNode -