Vant4 Vant4 Steps 步骤条

2024-02-25 开发教程 Vant4 匿名 10℃

介绍

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

引入

通过以下方式来全局注册组件，更多注册方式请参考组件注册。

import { createApp } from 'vue';
import { Step, Steps } from 'vant';
const app = createApp();
app.use(Step);
app.use(Steps);

代码演示

基础用法

active 属性表示当前步骤的索引，从 0 起计。

<van-steps :active="active">
  <van-step>买家下单</van-step>
  <van-step>商家接单</van-step>
  <van-step>买家提货</van-step>
  <van-step>交易完成</van-step>
</van-steps>

import { ref } from 'vue';
export default {
  setup() {
    const active = ref(1);
    return { active };
  },
};

自定义样式

可以通过 active-icon 和 active-color 属性设置激活状态下的图标和颜色。

<van-steps :active="active" active-icon="success" active-color="#07c160">
  <van-step>买家下单</van-step>
  <van-step>商家接单</van-step>
  <van-step>买家提货</van-step>
  <van-step>交易完成</van-step>
</van-steps>

竖向步骤条

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

<van-steps direction="vertical" :active="0">
  <van-step>
    <h3>【城市】物流状态1</h3>
    <p>2016-07-12 12:40</p>
  </van-step>
  <van-step>
    <h3>【城市】物流状态2</h3>
    <p>2016-07-11 10:00</p>
  </van-step>
  <van-step>
    <h3>快件已发货</h3>
    <p>2016-07-10 09:30</p>
  </van-step>
</van-steps>

API

Steps Props

参数	说明	类型	默认值
active	当前步骤对应的索引值	number \| string	`0`
direction	步骤条方向，可选值为 `vertical`	string	`horizontal`
active-icon	当前步骤对应的底部图标，可选值见 Icon 组件	string	`checked`
inactive-icon	非当前步骤对应的底部图标，可选值见 Icon 组件	string	-
finish-icon `v3.0.7`	已完成步骤对应的底部图标，优先级高于 `inactive-icon`，可选值见 Icon 组件	string	-
active-color	当前步骤和已完成步骤的颜色	string	`#07c160`
inactive-color	未激活步骤的颜色	string	`#969799`
icon-prefix `v3.0.15`	图标类名前缀，等同于 Icon 组件的 class-prefix 属性	string	`van-icon`

Step Slots

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

Steps Events

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

类型定义

组件导出以下类型定义：

import type { StepsProps, StepsDirection } from 'vant';

主题定制

样式变量

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

名称	默认值	描述
--van-step-text-color	var(--van-text-color-2)	-
--van-step-active-color	var(--van-primary-color)	-
--van-step-process-text-color	var(--van-text-color)	-
--van-step-font-size	var(--van-font-size-md)	-
--van-step-line-color	var(--van-border-color)	-
--van-step-finish-line-color	var(--van-primary-color)	-
--van-step-finish-text-color	var(--van-text-color)	-
--van-step-icon-size	12px	-
--van-step-circle-size	5px	-
--van-step-circle-color	var(--van-gray-6)	-
--van-step-horizontal-title-font-size	var(--van-font-size-sm)	-
--van-steps-background	var(--van-background-2)	-

上一节： Vant4 Skeleton 骨架屏

下一节： Vant4 Sticky 粘性布局

"Vant4"的目录