Tab 标签页

引入

  1. import Vue from 'vue';
  2. import { Tab, Tabs } from 'vant';
  3. Vue.use(Tab);
  4. Vue.use(Tabs);

代码演示

基础用法

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

  1. <van-tabs v-model="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. export default {
  2. data() {
  3. return {
  4. active: 2,
  5. };
  6. },
  7. };

通过名称匹配

在标签指定 name 属性的情况下,v-model 的值为当前标签的 name(此时无法通过索引值来匹配标签)。

  1. <van-tabs v-model="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. export default {
  2. data() {
  3. return {
  4. activeName: 'a',
  5. };
  6. },
  7. };

标签栏滚动

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

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

禁用标签

设置 disabled 属性即可禁用标签,如果需要监听禁用标签的点击事件,可以在 van-tabs 上监听disabled 事件。

  1. <van-tabs @disabled="onClickDisabled">
  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>
  1. import { Toast } from 'vant';
  2. export default {
  3. methods: {
  4. onClickDisabled(name, title) {
  5. Toast(name + '已被禁用');
  6. },
  7. },
  8. };

样式风格

Tab 支持两种样式风格:linecard,默认为 line 样式,可以通过 type 属性切换样式风格。

  1. <van-tabs type="card">
  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-tabs>

点击事件

可以在 van-tabs 上绑定 click 事件,事件传参为标签对应的标识符和标题。

  1. <van-tabs @click="onClick">
  2. <van-tab title="标签 1">内容 1</van-tab>
  3. <van-tab title="标签 2">内容 2</van-tab>
  4. </van-tabs>
  1. import { Toast } from 'vant';
  2. export default {
  3. methods: {
  4. onClick(name, title) {
  5. Toast(title);
  6. },
  7. },
  8. };

粘性布局

通过 sticky 属性可以开启粘性布局,粘性布局下,标签页滚动到顶部时会自动吸顶。

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

切换动画

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

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

滑动切换

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

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

滚动导航

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

  1. <van-tabs v-model="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 :before-change="beforeChange">
  2. <van-tab v-for="index in 4" :title="'选项 ' + index">
  3. 内容 {{ index }}
  4. </van-tab>
  5. </van-tabs>
  1. export default {
  2. methods: {
  3. beforeChange(index) {
  4. // 返回 false 表示阻止此次切换
  5. if (index === 1) {
  6. return false;
  7. }
  8. // 返回 Promise 来执行异步逻辑
  9. return new Promise((resolve) => {
  10. // 在 resolve 函数中返回 true 或 false
  11. resolve(index !== 3);
  12. });
  13. },
  14. },
  15. };

API

Tabs Props

参数说明类型默认值
v-model绑定当前选中标签的标识符number | string0
type样式风格类型,可选值为 cardstringline
color标签主题色string#ee0a24
background标签栏背景色stringwhite
duration动画时间,单位秒number | string0.3
line-width底部条宽度,默认单位 pxnumber | string40px
line-height底部条高度,默认单位 pxnumber | string3px
animated是否开启切换标签内容时的转场动画booleanfalse
border是否显示标签栏外边框,仅在 type=”line” 时有效booleanfalse
ellipsis是否省略过长的标题文字booleantrue
sticky是否使用粘性定位布局booleanfalse
swipeable是否开启手势滑动切换booleanfalse
lazy-render是否开启延迟渲染(首次切换到标签时才触发内容渲染)booleantrue
scrollspy v2.3.0是否开启滚动导航booleanfalse
offset-top v2.8.7粘性定位布局下与顶部的最小距离,支持 px vw vh rem 单位,默认 pxnumber | string0
swipe-threshold滚动阈值,标签数量超过阈值且总宽度超过标签栏宽度时开始横向滚动number | string5
title-active-color标题选中态颜色string-
title-inactive-color标题默认态颜色string-
before-change v2.9.3切换标签前的回调函数,返回 false 可阻止切换,支持返回 Promise(name) => boolean | Promise-

Tab Props

参数说明类型默认值
title标题string-
disabled是否禁用标签booleanfalse
dot v2.3.0是否在标题右上角显示小红点booleanfalse
badge v2.5.6图标右上角徽标的内容number | string-
info v2.3.0图标右上角徽标的内容(已废弃,请使用 badge 属性)number | string-
name标签名称,作为匹配的标识符number | string标签的索引值
url点击后跳转的链接地址string-
to点击后跳转的目标路由对象,同 vue-router 的 to 属性string | object-
replace是否在跳转时替换当前页面历史booleanfalse
title-style自定义标题样式any-

Tabs Events

事件名说明回调参数
click点击标签时触发name:标识符,title:标题
change当前激活的标签改变时触发name:标识符,title:标题
disabled点击被禁用的标签时触发name:标识符,title:标题
rendered v2.3.0标签内容首次渲染时触发(仅在开启延迟渲染后触发)name:标识符,title:标题
scroll滚动时触发,仅在 sticky 模式下生效{ scrollTop: 距离顶部位置, isFixed: 是否吸顶 }

Tabs 方法

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

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

Tabs Slots

名称说明
nav-left标题左侧内容
nav-right标题右侧内容

Tab Slots

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

样式变量

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

名称默认值描述
@tab-text-color@gray-7-
@tab-active-text-color@text-color-
@tab-disabled-text-color@gray-5-
@tab-font-size@font-size-md-
@tab-line-height@line-height-md-
@tabs-default-color@red-
@tabs-line-height44px-
@tabs-card-height30px-
@tabs-nav-background-color@white-
@tabs-bottom-bar-width40px-
@tabs-bottom-bar-height3px-
@tabs-bottom-bar-color@tabs-default-color-

常见问题

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

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

解决方法

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

  1. <!-- Before -->
  2. <van-tabs v-show="show" />
  3. <!-- After -->
  4. <van-tabs v-if="show" />

方法二,调用组件的 resize 方法来主动触发重绘:

  1. <van-tabs v-show="show" ref="tabs" />
  1. this.$refs.tabs.resize();

Tab 标签页 - 图1