Tab 标签页 ​

介绍 ​

选项卡组件，用于在不同的内容区域之间进行切换。

引入 ​

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

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

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

代码演示 ​

基础用法 ​

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

html
<van-tabs v-model:active="active">
  <van-tab title="标签 1">内容 1</van-tab>
  <van-tab title="标签 2">内容 2</van-tab>
  <van-tab title="标签 3">内容 3</van-tab>
  <van-tab title="标签 4">内容 4</van-tab>
</van-tabs>
js
import { ref } from 'vue';

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

通过名称匹配 ​

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

html
<van-tabs v-model:active="activeName">
  <van-tab title="标签 1" name="a">内容 1</van-tab>
  <van-tab title="标签 2" name="b">内容 2</van-tab>
  <van-tab title="标签 3" name="c">内容 3</van-tab>
</van-tabs>
js
import { ref } from 'vue';

export default {
  setup() {
    const activeName = ref('b');
    return { activeName };
  },
};

标签栏滚动 ​

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

html
<van-tabs v-model:active="active">
  <van-tab v-for="index in 8" :title="'标签 ' + index">
    内容 {{ index }}
  </van-tab>
</van-tabs>

禁用标签 ​

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

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

样式风格 ​

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

html
<van-tabs v-model:active="active" type="card">
  <van-tab title="标签 1">内容 1</van-tab>
  <van-tab title="标签 2">内容 2</van-tab>
  <van-tab title="标签 3">内容 3</van-tab>
</van-tabs>

点击事件 ​

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

html
<van-tabs v-model:active="active" @click-tab="onClickTab">
  <van-tab title="标签 1">内容 1</van-tab>
  <van-tab title="标签 2">内容 2</van-tab>
</van-tabs>
js
import { ref } from 'vue';
import { showToast } from '@szhn/dh-design-mobile';

export default {
  setup() {
    const active = ref(0);
    const onClickTab = ({ title }) => showToast(title);
    return {
      active,
      onClickTab,
    };
  },
};

粘性布局 ​

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

html
<van-tabs v-model:active="active" sticky>
  <van-tab v-for="index in 4" :title="'标签 ' + index">
    内容 {{ index }}
  </van-tab>
</van-tabs>

Tips: 如果页面顶部有其他内容，可以通过 offset-top 属性设置吸顶时与顶部的距离。

收缩布局 ​

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

html
<van-tabs v-model:active="active" shrink>
  <van-tab v-for="index in 4" :title="'标签 ' + index">
    内容 {{ index }}
  </van-tab>
</van-tabs>

<van-tabs v-model:active="active" shrink type="card">
  <van-tab v-for="index in 4" :title="'标签 ' + index">
    内容 {{ index }}
  </van-tab>
</van-tabs>

自定义标签 ​

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

html
<van-tabs v-model:active="active">
  <van-tab v-for="index in 2">
    <template #title><van-icon name="more-o" />标签</template>
    内容 {{ index }}
  </van-tab>
</van-tabs>

切换动画 ​

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

html
<van-tabs v-model:active="active" animated>
  <van-tab v-for="index in 4" :title="'标签 ' + index">
    内容 {{ index }}
  </van-tab>
</van-tabs>

滑动切换 ​

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

html
<van-tabs v-model:active="active" swipeable>
  <van-tab v-for="index in 4" :title="'标签 ' + index">
    内容 {{ index }}
  </van-tab>
</van-tabs>

滚动导航 ​

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

html
<van-tabs v-model:active="active" scrollspy sticky>
  <van-tab v-for="index in 8" :title="'标签 ' + index">
    内容 {{ index }}
  </van-tab>
</van-tabs>

异步切换 ​

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

html
<van-tabs v-model:active="active" :before-change="beforeChange">
  <van-tab v-for="index in 4" :title="'标签 ' + index">
    内容 {{ index }}
  </van-tab>
</van-tabs>
js
import { ref } from 'vue';

export default {
  setup() {
    const active = ref(0);
    const beforeChange = (index) => {
      // 返回 false 表示阻止此次切换
      if (index === 1) {
        return false;
      }

      // 返回 Promise 来执行异步逻辑
      return new Promise((resolve) => {
        // 在 resolve 函数中返回 true 或 false
        setTimeout(() => resolve(index !== 3), 1000);
      });
    };

    return {
      beforeChange,
    };
  },
};

Tips: 通过手势滑动不会触发 before-change 属性。

隐藏标题栏 ​

通过将 showHeader 属性设置为 false，可以不渲染 Tabs 的标题栏。在这种情况下，你可以通过一些自定义组件来控制 Tabs 的 active 属性。

html
<van-tabs v-model:active="active" :show-header="false">
  <van-tab v-for="index in 4">内容 {{ index }}</van-tab>
</van-tabs>

API ​

Tabs Props ​

参数说明类型默认值
v-model:active绑定当前选中标签的标识符number | string0
type样式风格类型，可选值为 cardstringline
color标签主题色string#1989fa
background标签栏背景色stringwhite
duration动画时间，单位秒，设置为 0 可以禁用动画number | string0.3
line-width底部条宽度，默认单位 pxnumber | string40px
line-height底部条高度，默认单位 pxnumber | string3px
animated是否开启切换标签内容时的转场动画（开启该属性后，内容区如果有粘性布局将会不达预期）booleanfalse
border是否显示标签栏外边框，仅在 type="line" 时有效booleanfalse
ellipsis是否省略过长的标题文字（仅在 shrink 为 false 且 tab 数量小于等于 swipe-threshold 时生效）booleantrue
sticky是否使用粘性布局booleanfalse
shrink是否开启左侧收缩布局booleanfalse
swipeable是否开启手势左右滑动切换（开启该属性后，内容区如果有粘性布局将会不达预期）booleanfalse
lazy-render是否开启延迟渲染（首次切换到标签时才触发内容渲染）booleantrue
scrollspy是否开启滚动导航booleanfalse
show-header v4.7.3是否显示标题栏booleantrue
offset-top粘性布局下吸顶时与顶部的距离，支持 px vw vh rem 单位，默认 pxnumber | string0
swipe-threshold滚动阈值，标签数量超过阈值且总宽度超过标签栏宽度时开始横向滚动（仅在 shrink 为 false 且 ellipsis 为 true 时生效）number | string5
title-active-color标题选中态颜色string-
title-inactive-color标题默认态颜色string-
before-change切换标签前的回调函数，返回 false 可阻止切换，支持返回 Promise(name: number | string) => boolean | Promise<boolean>-

Tab Props ​

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

Tabs Events ​

事件名说明回调参数
click-tab点击标签时触发{ name: string | number, title: string, event: MouseEvent, disabled: boolean }
change当前激活的标签改变时触发name: string | number, title: string
rendered标签内容首次渲染时触发（仅在开启延迟渲染后触发）name: string | number, title: string
scroll滚动时触发，仅在 sticky 模式下生效{ scrollTop: number, isFixed: boolean }

提示：click 和 disabled 事件已废弃，请使用 click-tab 事件代替。

Tabs 方法 ​

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

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

类型定义 ​

组件导出以下类型定义：

ts
import type { TabProps, TabsType, TabsProps, TabsInstance } from '@szhn/dh-design-mobile';

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

ts
import { ref } from 'vue';
import type { TabsInstance } from '@szhn/dh-design-mobile';

const tabsRef = ref<TabsInstance>();

tabsRef.value?.scrollTo(0);

Tabs Slots ​

名称说明
nav-left标签栏左侧内容
nav-right标签栏右侧内容
nav-bottom标签栏下方内容

Tab Slots ​

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

主题定制 ​

样式变量 ​

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

名称默认值描述
--van-tab-text-colorvar(--van-gray-7)标签页默认文字颜色
--van-tab-active-text-colorvar(--van-text-color)激活标签的文字颜色
--van-tab-disabled-text-colorvar(--van-text-color-3)禁用状态下标签的文字颜色
--van-tab-font-sizevar(--van-font-size-md)标签页的字体大小
--van-tab-line-heightvar(--van-line-height-md)标签页的行高
--van-tabs-default-colorvar(--van-primary-color)标签栏默认主题色
--van-tabs-line-height44px标签栏的高度
--van-tabs-card-height30px卡片类型标签栏的高度
--van-tabs-nav-backgroundvar(--van-background-2)标签栏导航的背景色
--van-tabs-bottom-bar-width40px底部激活条的宽度
--van-tabs-bottom-bar-height3px底部激活条的高度
--van-tabs-bottom-bar-colorvar(--van-primary-color)底部激活条的颜色

常见问题 ​

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

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

解决方法 ​

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

html
<!-- Before -->
<van-tabs v-show="show" />
<!-- After -->
<van-tabs v-if="show" />

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

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

Tabs 开启 swipeable 或 animated 属性后，内容区元素的 sticky 功能将不达预期 ​

Tabs 开启 swipeable 或 animated 属性后，内容区将被带有 transform 属性的元素包裹，此时如果内容区的元素开启了 sticky 功能，那么该功能生效了，但显示位置将不达预期。

比如下面的代码：

html
<van-tabs v-model:active="active" swipeable>
  <van-tab>
    <van-sticky>
      <van-button>sticky button</van-button>
    </van-sticky>
  </van-tab>
</van-tabs>

这是因为 transform 元素内部的 fixed 定位会相对于该元素进行计算，而不是相对于整个文档，从而导致布局异常。

如何判断当前组件是否处于激活的 Tab 内？ ​

可以在子组件中通过调用 useTabStatus 或 useAllTabStatus 来判断当前组件是否处于激活的 Tab 内部。

  • useTabStatus：返回当前组件所在的 Tab 是否为激活状态，若组件不在 Tab 内部则返回 null。
  • useAllTabStatus：在存在嵌套 Tab 的场景下，返回是否所有上层 Tab 为激活状态，若组件不在 Tab 内部则返回 null。
js
const isActive = useTabStatus();
// 嵌套 Tab 场景
const isAllActive = useAllTabStatus();