Tab 标签页

引入

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

基础用法

通过 绑定当前激活标签对应的索引值，默认情况下启用第一个标签。

  1. <van-tabs v-model:active="active">
  2.   <van-tab title="标签 1">内容 1</van-tab>
  3.   <van-tab title="标签 2">内容 2</van-tab>
  4.   <van-tab title="标签 3">内容 3</van-tab>
  5.   <van-tab title="标签 4">内容 4</van-tab>
  6. </van-tabs>
  1. import { ref } from 'vue';
  3. export default {
  4.   setup() {
  5.     const active = ref(0);
  6.     return { active };
  7.   },
  8. };

通过名称匹配

在标签指定 name 属性的情况下，v-model:active 的值为当前标签的 name（此时无法通过索引值来匹配标签）。

  1. <van-tabs v-model:active="activeName">
  2.   <van-tab title="标签 1" name="a">内容 1</van-tab>
  3.   <van-tab title="标签 2" name="b">内容 2</van-tab>
  4.   <van-tab title="标签 3" name="c">内容 3</van-tab>
  5. </van-tabs>
  1. import { ref } from 'vue';
  2. export default {
  3.   setup() {
  4.     const activeName = ref('a');
  5.     return { activeName };
  6.   },
  7. };

标签栏滚动

标签数量超过 5 个时，标签栏可以在水平方向上滚动，切换时会自动将当前标签居中。

  1. <van-tabs v-model:active="active">
  2.   <van-tab v-for="index in 8" :title="'标签 ' + index">
  3.     内容 {{ index }}
  4.   </van-tab>
  5. </van-tabs>

禁用标签

设置 disabled 属性即可禁用标签。

  1. <van-tabs v-model:active="active">
  2.   <van-tab title="标签 1">内容 1</van-tab>
  3.   <van-tab title="标签 2" disabled>内容 2</van-tab>
  4.   <van-tab title="标签 3">内容 3</van-tab>
  5. </van-tabs>

样式风格

Tab 支持两种样式风格：line 和card，默认为 line 样式，可以通过 type 属性切换样式风格。

点击事件

点击标签页时，会触发 click-tab 事件。

  1. <van-tabs v-model:active="active" @click-tab="onClickTab">
  2.   <van-tab title="标签 1">内容 1</van-tab>
  3.   <van-tab title="标签 2">内容 2</van-tab>
  4. </van-tabs>
  1. import { ref } from 'vue';
  2. import { Toast } from 'vant';
  4. export default {
  5.   setup() {
  6.     const active = ref(0);
  8.     return {
  9.       active,
  10.       onClickTab,
  11.     };
  12.   },
  13. };
  1. <van-tabs v-model:active="active" sticky>
  2.   <van-tab v-for="index in 4" :title="'选项 ' + index">
  3.     内容 {{ index }}
  4.   </van-tab>
  5. </van-tabs>

收缩布局

通过 shrink 属性可以开启收缩布局，开启后，所有的标签会向左侧收缩对齐。

  1. <van-tabs v-model:active="active" shrink>
  2.   <van-tab v-for="index in 4" :title="'选项 ' + index">
  3.     内容 {{ index }}
  4.   </van-tab>
  5. </van-tabs>

自定义标签

通过 title 插槽可以自定义标签内容。

  1. <van-tabs v-model:active="active">
  2.   <van-tab v-for="index in 2">
  3.     <template #title> <van-icon name="more-o" />选项 </template>
  4.     内容 {{ index }}
  5.   </van-tab>
  6. </van-tabs>

切换动画

通过 animated 属性可以开启切换标签内容时的转场动画。

  1.   <van-tab v-for="index in 4" :title="'选项 ' + index">
  2.     内容 {{ index }}
  3.   </van-tab>
  4. </van-tabs>

滑动切换

通过 swipeable 属性可以开启滑动切换标签页。

滚动导航

通过 scrollspy 属性可以开启滚动导航模式，该模式下，内容将会平铺展示。

  1. <van-tabs v-model:active="active" scrollspy sticky>
  2.   <van-tab v-for="index in 8" :title="'选项 ' + index">
  3.     内容 {{ index }}
  4.   </van-tab>
  5. </van-tabs>

异步切换

通过 before-change 属性可以在切换标签前执行特定的逻辑。

  1. <van-tabs v-model:active="active" :before-change="beforeChange">
  2.   <van-tab v-for="index in 4" :title="'选项 ' + index">
  3.     内容 {{ index }}
  4.   </van-tab>
  5. </van-tabs>
  1. import { ref } from 'vue';
  3. export default {
  4.   setup() {
  5.     const active = ref(0);
  6.     const beforeChange = (index) => {
  7.       // 返回 false 表示阻止此次切换
  8.       if (index === 1) {
  9.         return false;
  10.       }
  12.       // 返回 Promise 来执行异步逻辑
  13.       return new Promise((resolve) => {
  15.         resolve(index !== 3);
  16.       });
  17.     };
  19.     return {
  20.       beforeChange,
  21.     };
  22.   },
  23. };

Tabs Props

参数说明类型默认值
title标题string-
disabled是否禁用标签booleanfalse
dot是否在标题右上角显示小红点booleanfalse
badge图标右上角徽标的内容number | string-
name标签名称，作为匹配的标识符number | string标签的索引值
url点击后跳转的链接地址string-
to点击后跳转的目标路由对象，等同于 vue-router 的 string | object-
replace是否在跳转时替换当前页面历史booleanfalse
title-style自定义标题样式string | Array | object-
title-class自定义标题类名string | Array | object-
show-zero-badge v3.2.2当 badge 为数字 0 时，是否展示徽标booleantrue

Tabs Events

Tabs 方法

通过 ref 可以获取到 Tabs 实例并调用实例方法，详见组件实例方法。

方法名说明参数返回值
resize外层元素大小或组件显示状态变化时，可以调用此方法来触发重绘--
scrollTo滚动到指定的标签页，在滚动导航模式下可用name: string | number-

类型定义

组件导出以下类型定义：

  1. import type { TabProps, TabsType, TabsProps, TabsInstance } from 'vant';

TabsInstance 是组件实例的类型，用法如下：

  1. import { ref } from 'vue';
  2. import type { TabsInstance } from 'vant';
  4. const tabsRef = ref<TabsInstance>();
  6. tabsRef.value?.scrollTo(0);

Tabs Slots

Tab Slots

名称说明
default标签页内容
title自定义标题

样式变量

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

组件从隐藏状态切换到显示状态时，底部条位置错误？

Tabs 组件在挂载时，会获取自身的宽度，并计算出底部条的位置。如果组件一开始处于隐藏状态，则获取到的宽度永远为 0，因此无法展示底部条位置。

解决方法

方法一，如果是使用 v-show 来控制组件展示的，则替换为 v-if 即可解决此问题：

  1. <!-- Before -->
  2. <van-tabs v-show="show" />
  3. <!-- After -->
  1. this.$refs.tabs.resize();