跳到正文

Steps 步骤条

Steps 用一组带编号的 Step 有序列表展示流程进行到哪一步。current 之前的步骤已完成,之后的步骤在等待,当前步骤带有 aria-current="step"。

每种状态各有颜色:已完成为绿色,进行中为蓝色,失败为红色,等待为灰色。横向排列时,连接线紧跟在标题后面、和标题在同一行,一直延伸到下一步的标记;描述放在第二行。窄屏下文字移到标记下方。

演示

交互

用按钮或点击标题切换步骤,并设置当前步骤的状态或任一步骤自己的状态。current 可以比最后一步再多一,此时所有步骤都已完成。

基础用法

current 从 1 开始计数。每个 Step 接受 title 和 description(或 children)。

状态

status 设置当前步骤的状态:process(默认)、finish、error 或 wait。Step 自己的 status 优先于由 current 推出的状态。

尺寸

垂直排列

自定义图标

finishIcon 和 errorIcon 替换所有步骤的对勾和叉号;Step 的 icon 在等待或进行中时替换它的编号。

可点击

设置 onUpdateCurrent 后,每个步骤的标题都变成覆盖整个步骤的按钮,点击时回传该步骤的编号。disabled 让某一步不能被选中。

Steps Props

名称类型默认值说明版本
currentnumberundefined当前步骤,从 1 开始计数。不设置时所有步骤都处于进行中。未发布
defaultCurrentnumberundefined非受控时的初始当前步骤。未发布
statusprocess | finish | error | waitprocess当前步骤的状态。未发布
sizesmall | mediummedium标记和文字的大小。未发布
verticalbooleanfalse纵向排列。未发布
finishIconReactNodeundefined替换已完成步骤的对勾。未发布
errorIconReactNodeundefined替换出错步骤的叉号。未发布
onUpdateCurrent(current: number) => voidundefined点击步骤时回传它的编号。设置后步骤可点击。未发布

Step Props

名称类型默认值说明版本
titleReactNodeundefined步骤标题。未发布
descriptionReactNodeundefined显示在标题下方;有 children 时以 children 为准。未发布
statusprocess | finish | error | waitundefined覆盖由 current 推出的状态。未发布
iconReactNodeundefined在等待或进行中时替换编号。未发布
disabledbooleanfalse不能被点击。未发布

finishIcon、errorIcon、icon、title 都接受任意 ReactNode。