Tabbar 标签栏

介绍

底部导航栏,用于在不同页面之间进行切换。

引入

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

  1. import { createApp } from 'vue';
  2. import { Tabbar, TabbarItem } from 'vant';
  3. const app = createApp();
  4. app.use(Tabbar);
  5. app.use(TabbarItem);

代码演示

基础用法

v-model 默认绑定选中标签的索引值,通过修改 v-model 即可切换选中的标签。

  1. <van-tabbar v-model="active">
  2. <van-tabbar-item icon="home-o">标签</van-tabbar-item>
  3. <van-tabbar-item icon="search">标签</van-tabbar-item>
  4. <van-tabbar-item icon="friends-o">标签</van-tabbar-item>
  5. <van-tabbar-item icon="setting-o">标签</van-tabbar-item>
  6. </van-tabbar>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const active = ref(0);
  5. return { active };
  6. },
  7. };

通过名称匹配

在标签指定 name 属性的情况下,v-model 的值为当前标签的 name

  1. <van-tabbar v-model="active">
  2. <van-tabbar-item name="home" icon="home-o">标签</van-tabbar-item>
  3. <van-tabbar-item name="search" icon="search">标签</van-tabbar-item>
  4. <van-tabbar-item name="friends" icon="friends-o">标签</van-tabbar-item>
  5. <van-tabbar-item name="setting" icon="setting-o">标签</van-tabbar-item>
  6. </van-tabbar>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const active = ref('home');
  5. return { active };
  6. },
  7. };

徽标提示

设置 dot 属性后,会在图标右上角展示一个小红点;设置 badge 属性后,会在图标右上角展示相应的徽标。

  1. <van-tabbar v-model="active">
  2. <van-tabbar-item icon="home-o">标签</van-tabbar-item>
  3. <van-tabbar-item icon="search" dot>标签</van-tabbar-item>
  4. <van-tabbar-item icon="friends-o" badge="5">标签</van-tabbar-item>
  5. <van-tabbar-item icon="setting-o" badge="20">标签</van-tabbar-item>
  6. </van-tabbar>

自定义图标

通过 icon 插槽自定义图标,可以通过 slot-scope 判断标签是否选中。

  1. <van-tabbar v-model="active">
  2. <van-tabbar-item badge="3">
  3. <span>自定义</span>
  4. <template #icon="props">
  5. <img :src="props.active ? icon.active : icon.inactive" />
  6. </template>
  7. </van-tabbar-item>
  8. <van-tabbar-item icon="search">标签</van-tabbar-item>
  9. <van-tabbar-item icon="setting-o">标签</van-tabbar-item>
  10. </van-tabbar>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const active = ref(0);
  5. const icon = {
  6. active: 'https://cdn.jsdelivr.net/npm/@vant/assets/user-active.png',
  7. inactive: 'https://cdn.jsdelivr.net/npm/@vant/assets/user-inactive.png',
  8. };
  9. return {
  10. icon,
  11. active,
  12. };
  13. },
  14. };

自定义颜色

通过 active-color 属性设置选中标签的颜色,通过 inactive-color 属性设置未选中标签的颜色。

  1. <van-tabbar v-model="active" active-color="#ee0a24" inactive-color="#000">
  2. <van-tabbar-item icon="home-o">标签</van-tabbar-item>
  3. <van-tabbar-item icon="search">标签</van-tabbar-item>
  4. <van-tabbar-item icon="friends-o">标签</van-tabbar-item>
  5. <van-tabbar-item icon="setting-o">标签</van-tabbar-item>
  6. </van-tabbar>

监听切换事件

通过 change 事件来监听选中标签的变化。

  1. <van-tabbar v-model="active" @change="onChange">
  2. <van-tabbar-item icon="home-o">标签 1</van-tabbar-item>
  3. <van-tabbar-item icon="search">标签 2</van-tabbar-item>
  4. <van-tabbar-item icon="friends-o">标签 3</van-tabbar-item>
  5. <van-tabbar-item icon="setting-o">标签 4</van-tabbar-item>
  6. </van-tabbar>
  1. import { ref } from 'vue';
  2. import { Toast } from 'vant';
  3. export default {
  4. setup() {
  5. const active = ref(0);
  6. const onChange = (index) => Toast(`标签 ${index}`);
  7. return {
  8. icon,
  9. onChange,
  10. };
  11. },
  12. };

路由模式

标签栏支持路由模式,用于搭配 vue-router 使用。路由模式下会匹配页面路径和标签的 to 属性,并自动选中对应的标签。

  1. <router-view />
  2. <van-tabbar route>
  3. <van-tabbar-item replace to="/home" icon="home-o">标签</van-tabbar-item>
  4. <van-tabbar-item replace to="/search" icon="search">标签</van-tabbar-item>
  5. </van-tabbar>

API

Tabbar Props

参数说明类型默认值
v-model当前选中标签的名称或索引值number | string0
fixed是否固定在底部booleantrue
border是否显示外边框booleantrue
z-index元素 z-indexnumber | string1
active-color选中标签的颜色string#1989fa
inactive-color未选中标签的颜色string#7d7e80
route是否开启路由模式booleanfalse
placeholder固定在底部时,是否在标签位置生成一个等高的占位元素booleanfalse
safe-area-inset-bottom是否开启底部安全区适配,设置 fixed 时默认开启booleanfalse
before-change切换标签前的回调函数,返回 false 可阻止切换,支持返回 Promise(name: number | string) => boolean | Promise<boolean>-

Tabbar Events

事件名说明回调参数
change切换标签时触发active: number | string

TabbarItem Props

参数说明类型默认值
name标签名称,作为匹配的标识符number | string当前标签的索引值
icon图标名称或图片链接,等同于 Icon 组件的 name 属性string-
icon-prefix图标类名前缀,等同于 Icon 组件的 class-prefix 属性stringvan-icon
dot是否显示图标右上角小红点booleanfalse
badge图标右上角徽标的内容number | string-
badge-props v3.2.8自定义徽标的属性,传入的对象会被透传给 Badge 组件的 propsBadgeProps-
url点击后跳转的链接地址string-
to点击后跳转的目标路由对象,等同于 vue-router 的 to 属性string | object-
replace是否在跳转时替换当前页面历史booleanfalse

TabbarItem Slots

名称说明参数
icon自定义图标active: boolean

类型定义

组件导出以下类型定义:

  1. import type { TabbarProps, TabbarItemProps } from 'vant';

主题定制

样式变量

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

名称默认值描述
—van-tabbar-height50px-
—van-tabbar-z-index1-
—van-tabbar-background-colorvar(—van-background-color-light)-
—van-tabbar-item-font-sizevar(—van-font-size-sm)-
—van-tabbar-item-text-colorvar(—van-gray-7)-
—van-tabbar-item-active-colorvar(—van-primary-color)-
—van-tabbar-item-active-background-colorvar(—van-background-color-light)-
—van-tabbar-item-line-height1-
—van-tabbar-item-icon-size22px-
—van-tabbar-item-icon-margin-bottomvar(—van-padding-base)-

Tabbar 标签栏 - 图1