Skip to content

Steps 步骤条 ​

使用
import { KSteps } from "@ksware/ksw-ux";

引导用户按照流程完成任务的分步导航条, 可根据实际应用场景设定步骤。

基础用法 ​

简单的步骤条。

设置 active 属性,接受一个 Number,表明步骤的 index,从 0 开始。 需要定宽的步骤条时,设置 space 属性即可,它接受 Number, 单位为 px, 如果不设置,则为自适应。 设置 finish-status 属性可以改变已经完成的步骤的状态。

胶囊状步骤条 ​

步骤条可以变成胶囊状,设置 capsule 属性为 true 即可。

自定义胶囊状步骤条样式 ​

当capsule 属性为 true时,步骤条的高度和颜色可以通过color和height属性来自定义。

含状态的步骤条 ​

可以通过 k-step 的status属性来设置步骤的状态,可选 wait、process、finish、error 四种状态。

居中的步骤条 ​

可以通过 k-steps 的 align-center 属性让步骤条居中。

带描述的步骤条 ​

可以通过 k-step 的 description 属性来为每一个步骤添加描述。

带图标的步骤条 ​

可以在步骤条中使用各种自定义图标。

通过 icon 属性来设置图标, 图标的类型可以参考 Icon 组件的文档, 除此以外,还能通过具名 slot 来使用自定义的图标。

垂直的步骤条 ​

垂直方向的步骤条。

只需要在 k-steps 元素中设置 direction 属性为 vertical 即可。

简洁风格的步骤条 ​

设置 simple 可应用简洁风格,该条件下 align-center / description / direction / space 都将失效。

Steps API ​

Steps Props ​

参数名描述类型默认值
space每个步骤条的间距,不填写将自适应间距,支持百分比string | number''
direction步骤条显示方向enum'horizontal'
active设置当前激活步骤number0
process-status设置步骤条当前状态string | enum'finish'
finish-status设置步骤条结束状态string | enum'success'
wait-status 1.2.4设置步骤条等待状态string | enum'wait'
align-center是否居中显示booleanfalse
simple是否简洁风格booleanfalse
capsule是否显示胶囊型步骤条booleanfalse
heightcapsule 为 true 时有效,步骤条高度string | number-
use-ant-style是否使用 Ant 样式booleanfalse
text-color 1.2.4设置步骤条文字颜色string | Function-

Steps Slots ​

插槽名描述参数
default默认插槽,用于放置 KStep 子标签-

Step API ​

Step Props ​

参数名描述类型默认值
title标题string''
description描述信息string''
icon步骤条图标string | Component-
status设置步骤条当前状态enum-
colorcapsule 为 true 时有效,设置步骤条填充颜色string-
text-colorcapsule 为 true 时有效,设置步骤条文本颜色string-
process-status 1.2.4设置步骤条当前状态string | enum-
finish-status 1.2.4设置步骤条完成状态string | enum-
wait-status 1.2.4设置步骤条等待状态string | enum-

Step Slots ​

插槽名描述参数
icon自定义图标-
title自定义标题-
description自定义描述信息-