Skip to content

Steps 步骤条

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

基础用法

自定义样式

自定义单个步骤图标

自定义间隔

垂直的步骤条

API

Steps Props

参数说明类型默认值
active当前步骤对应的索引值number | string0
active-icon当前步骤对应的底部图标,可选值见 Icon 组件string-
finish-icon已完成步骤对应的底部图标,优先级高于 inactive-icon,可选值见 Icon 组件string-
inactive-icon未完成步骤对应的底部图标,可选值见 Icon 组件string-
direction步骤条方向,可选值为 verticalstringhorizontal
icon-prefix图标类名前缀,等同于 Icon 组件的 class-prefix 属性stringr-icon

Steps Events

事件名说明回调参数
click-step点击步骤的标题或图标时触发index: number

Steps Slots

事件名说明回调参数
default默认插槽-
interval自定义步骤间隔-

Step Slots

名称说明
default步骤内容
active-icon自定义激活状态图标
inactive-icon自定义未激活状态图标
finish-icon自定义已完成步骤对应的底部图标,优先级高于 inactive-icon

类型定义

组件导出以下类型定义:

ts
import type { StepsProps, StepsDirection } from 'ryxon'

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--r-step-text-colorvar(--r-text-color-2)步骤条默认文字颜色
--r-step-active-colorvar(--r-primary-color)步骤条激活状态下文字颜色
--r-step-font-sizevar(--r-font-size-md)-
--r-step-line-colorvar(--r-border-color)-
--r-step-finish-line-colorvar(--r-success-color)-
--r-step-finish-text-colorvar(--r-success-color)-
--r-step-icon-size12px-
--r-step-circle-size5px-
--r-step-circle-colorvar(--r-info-color)-
--r-step-horizontal-title-font-sizevar(--r-font-size-sm)-
--r-steps-backgroundvar(--r-background-2)步骤条背景颜色

Released under the MIT License.