Skip to content

Steps 步骤条 ​

介绍 ​

用于展示操作流程的各个环节,让用户了解当前的操作在整体流程中的位置。

引入 ​

通过以下方式来引入组件。

js
import { createApp } from 'vue';
import { Steps } from '@szhn/dh-design-mobile';

const app = createApp();
app.use(Steps);

代码演示 ​

基础用法 ​

active 属性表示当前步骤的索引,从 0 起计。默认使用 22px 大圆:当前步骤为主色实心编号,已完成为黑色圆勾,未完成为灰色编号。

html
<van-steps :active="active">
  <van-step>
    买家下单
    <span class="dh-step__desc">说明文字</span>
  </van-step>
  <van-step>
    商家接单
    <span class="dh-step__desc">说明文字</span>
  </van-step>
  <van-step>
    买家提货
    <span class="dh-step__desc">说明文字</span>
  </van-step>
  <van-step>
    交易完成
    <span class="dh-step__desc">说明文字</span>
  </van-step>
</van-steps>
js
import { ref } from 'vue';

export default {
  setup() {
    const active = ref(1);
    return { active };
  },
};

圆点样式 ​

通过 dh-steps--dot 使用 8px 圆点:当前步骤为主色实心,已完成为主色描边,未完成为 #C0C0C0 描边。

html
<van-steps :active="active" class="dh-steps--dot">
  <van-step>
    买家下单
    <span class="dh-step__desc">说明文字</span>
  </van-step>
  <van-step>
    商家接单
    <span class="dh-step__desc">说明文字</span>
  </van-step>
  <van-step>
    买家提货
    <span class="dh-step__desc">说明文字</span>
  </van-step>
  <van-step>
    交易完成
    <span class="dh-step__desc">说明文字</span>
  </van-step>
</van-steps>

竖向步骤条 ​

可以通过设置 direction 属性来改变步骤条的显示方向。

html
<van-steps direction="vertical" :active="1">
  <van-step>
    完成
    <span class="dh-step__desc">说明文字</span>
  </van-step>
  <van-step>
    当前
    <span class="dh-step__desc">说明文字</span>
  </van-step>
  <van-step>
    默认
    <span class="dh-step__desc">说明文字</span>
  </van-step>
</van-steps>

竖向圆点 ​

竖向布局同样可以使用 dh-steps--dot。

html
<van-steps direction="vertical" :active="1" class="dh-steps--dot">
  <van-step>
    完成
    <span class="dh-step__desc">说明文字</span>
  </van-step>
  <van-step>
    当前
    <span class="dh-step__desc">说明文字</span>
  </van-step>
  <van-step>
    默认
    <span class="dh-step__desc">说明文字</span>
  </van-step>
</van-steps>

API ​

Steps Props ​

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

Step Slots ​

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

Steps Events ​

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

类型定义 ​

组件导出以下类型定义:

ts
import type { StepsProps, StepsDirection } from '@szhn/dh-design-mobile';

主题定制 ​

样式变量 ​

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

名称默认值描述
--van-step-text-color#999999-
--van-step-active-colorvar(--dh-mobile-color-primary)-
--van-step-process-text-colorvar(--dh-mobile-color-primary)-
--van-step-font-sizevar(--dh-mobile-font-size-base)-
--van-step-line-color#EDEDED-
--van-step-finish-line-colorvar(--dh-mobile-color-primary)-
--van-step-finish-text-color#000000-
--van-step-icon-size22px-
--van-step-circle-size22px-
--van-step-circle-colortransparent-
--van-step-horizontal-title-font-sizevar(--dh-mobile-font-size-base)-
--van-steps-backgroundvar(--dh-mobile-color-surface)-
Steps