Vant4 Tab 標(biāo)簽頁

2023-02-16 17:56 更新

介紹

選項卡組件,用于在不同的內(nèi)容區(qū)域之間進行切換。

引入

通過以下方式來全局注冊組件,更多注冊方式請參考組件注冊。

import { createApp } from 'vue';
import { Tab, Tabs } from 'vant';

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

代碼演示

基礎(chǔ)用法

通過 ?v-model:active? 綁定當(dāng)前激活標(biāo)簽對應(yīng)的索引值,默認情況下啟用第一個標(biāo)簽。

<van-tabs v-model:active="active">
  <van-tab title="標(biāo)簽 1">內(nèi)容 1</van-tab>
  <van-tab title="標(biāo)簽 2">內(nèi)容 2</van-tab>
  <van-tab title="標(biāo)簽 3">內(nèi)容 3</van-tab>
  <van-tab title="標(biāo)簽 4">內(nèi)容 4</van-tab>
</van-tabs>
import { ref } from 'vue';

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

通過名稱匹配

在標(biāo)簽指定 ?name? 屬性的情況下,?v-model:active? 的值為當(dāng)前標(biāo)簽的 ?name?(此時無法通過索引值來匹配標(biāo)簽)。

<van-tabs v-model:active="activeName">
  <van-tab title="標(biāo)簽 1" name="a">內(nèi)容 1</van-tab>
  <van-tab title="標(biāo)簽 2" name="b">內(nèi)容 2</van-tab>
  <van-tab title="標(biāo)簽 3" name="c">內(nèi)容 3</van-tab>
</van-tabs>
import { ref } from 'vue';

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

標(biāo)簽欄滾動

標(biāo)簽數(shù)量超過 5 個時,標(biāo)簽欄可以在水平方向上滾動,切換時會自動將當(dāng)前標(biāo)簽居中。

<van-tabs v-model:active="active">
  <van-tab v-for="index in 8" :title="'標(biāo)簽 ' + index">
    內(nèi)容 {{ index }}
  </van-tab>
</van-tabs>

禁用標(biāo)簽

設(shè)置 ?disabled? 屬性即可禁用標(biāo)簽。

<van-tabs v-model:active="active">
  <van-tab title="標(biāo)簽 1">內(nèi)容 1</van-tab>
  <van-tab title="標(biāo)簽 2" disabled>內(nèi)容 2</van-tab>
  <van-tab title="標(biāo)簽 3">內(nèi)容 3</van-tab>
</van-tabs>

樣式風(fēng)格

?Tab? 支持兩種樣式風(fēng)格:?line? 和?card?,默認為 ?line? 樣式,可以通過 ?type? 屬性切換樣式風(fēng)格。

<van-tabs v-model:active="active" type="card">
  <van-tab title="標(biāo)簽 1">內(nèi)容 1</van-tab>
  <van-tab title="標(biāo)簽 2">內(nèi)容 2</van-tab>
  <van-tab title="標(biāo)簽 3">內(nèi)容 3</van-tab>
</van-tabs>

點擊事件

點擊標(biāo)簽頁時,會觸發(fā) ?click-tab? 事件。

<van-tabs v-model:active="active" @click-tab="onClickTab">
  <van-tab title="標(biāo)簽 1">內(nèi)容 1</van-tab>
  <van-tab title="標(biāo)簽 2">內(nèi)容 2</van-tab>
</van-tabs>
import { ref } from 'vue';
import { showToast } from 'vant';

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

粘性布局

通過 ?sticky? 屬性可以開啟粘性布局,粘性布局下,標(biāo)簽頁滾動到頂部時會自動吸頂。

<van-tabs v-model:active="active" sticky>
  <van-tab v-for="index in 4" :title="'選項 ' + index">
    內(nèi)容 {{ index }}
  </van-tab>
</van-tabs>
Tips: 如果頁面頂部有其他內(nèi)容,可以通過 offset-top 屬性設(shè)置吸頂時與頂部的距離。

收縮布局

通過 ?shrink? 屬性可以開啟收縮布局,開啟后,所有的標(biāo)簽會向左側(cè)收縮對齊。

<van-tabs v-model:active="active" shrink>
  <van-tab v-for="index in 4" :title="'選項 ' + index">
    內(nèi)容 {{ index }}
  </van-tab>
</van-tabs>

自定義標(biāo)簽

通過 ?title? 插槽可以自定義標(biāo)簽內(nèi)容。

<van-tabs v-model:active="active">
  <van-tab v-for="index in 2">
    <template #title> <van-icon name="more-o" />選項 </template>
    內(nèi)容 {{ index }}
  </van-tab>
</van-tabs>

切換動畫

通過 ?animated? 屬性可以開啟切換標(biāo)簽內(nèi)容時的轉(zhuǎn)場動畫。

<van-tabs v-model:active="active" animated>
  <van-tab v-for="index in 4" :title="'選項 ' + index">
    內(nèi)容 {{ index }}
  </van-tab>
</van-tabs>

滑動切換

通過 ?swipeable? 屬性可以開啟滑動切換標(biāo)簽頁。

<van-tabs v-model:active="active" swipeable>
  <van-tab v-for="index in 4" :title="'選項 ' + index">
    內(nèi)容 {{ index }}
  </van-tab>
</van-tabs>

滾動導(dǎo)航

通過 ?scrollspy? 屬性可以開啟滾動導(dǎo)航模式,該模式下,內(nèi)容將會平鋪展示。

<van-tabs v-model:active="active" scrollspy sticky>
  <van-tab v-for="index in 8" :title="'選項 ' + index">
    內(nèi)容 {{ index }}
  </van-tab>
</van-tabs>

異步切換

通過 ?before-change? 屬性可以在切換標(biāo)簽前執(zhí)行特定的邏輯。

<van-tabs v-model:active="active" :before-change="beforeChange">
  <van-tab v-for="index in 4" :title="'選項 ' + index">
    內(nèi)容 {{ index }}
  </van-tab>
</van-tabs>
import { ref } from 'vue';

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

      // 返回 Promise 來執(zhí)行異步邏輯
      return new Promise((resolve) => {
        // 在 resolve 函數(shù)中返回 true 或 false
        resolve(index !== 3);
      });
    };

    return {
      beforeChange,
    };
  },
};
Tips: 通過手勢滑動不會觸發(fā) before-change 屬性。

API

Tabs Props

參數(shù) 說明 類型 默認值
v-model:active 綁定當(dāng)前選中標(biāo)簽的標(biāo)識符 number | string 0
type 樣式風(fēng)格類型,可選值為 card string line
color 標(biāo)簽主題色 string #1989fa
background 標(biāo)簽欄背景色 string white
duration 動畫時間,單位秒,設(shè)置為 0 可以禁用動畫 number | string 0.3
line-width 底部條寬度,默認單位 px number | string 40px
line-height 底部條高度,默認單位 px number | string 3px
animated 是否開啟切換標(biāo)簽內(nèi)容時的轉(zhuǎn)場動畫 boolean false
border 是否顯示標(biāo)簽欄外邊框,僅在 type="line" 時有效 boolean false
ellipsis 是否省略過長的標(biāo)題文字 boolean true
sticky 是否使用粘性布局 boolean false
shrink v3.2.8 是否開啟左側(cè)收縮布局 boolean false
swipeable 是否開啟手勢左右滑動切換 boolean false
lazy-render 是否開啟延遲渲染(首次切換到標(biāo)簽時才觸發(fā)內(nèi)容渲染) boolean true
scrollspy 是否開啟滾動導(dǎo)航 boolean false
offset-top 粘性布局下吸頂時與頂部的距離,支持 px vw vh rem 單位,默認 px number | string 0
swipe-threshold 滾動閾值,標(biāo)簽數(shù)量超過閾值且總寬度超過標(biāo)簽欄寬度時開始橫向滾動 number | string 5
title-active-color 標(biāo)題選中態(tài)顏色 string -
title-inactive-color 標(biāo)題默認態(tài)顏色 string -
before-change 切換標(biāo)簽前的回調(diào)函數(shù),返回 false 可阻止切換,支持返回 Promise (name: number | string) => boolean | Promise<boolean> -

Tab Props

參數(shù) 說明 類型 默認值
title 標(biāo)題 string -
disabled 是否禁用標(biāo)簽 boolean false
dot 是否在標(biāo)題右上角顯示小紅點 boolean false
badge 圖標(biāo)右上角徽標(biāo)的內(nèi)容 number | string -
name 標(biāo)簽名稱,作為匹配的標(biāo)識符 number | string 標(biāo)簽的索引值
url 點擊后跳轉(zhuǎn)的鏈接地址 string -
to 點擊后跳轉(zhuǎn)的目標(biāo)路由對象,等同于 vue-router 的 to 屬性 string | object -
replace 是否在跳轉(zhuǎn)時替換當(dāng)前頁面歷史 boolean false
title-style 自定義標(biāo)題樣式 string | Array | object -
title-class 自定義標(biāo)題類名 string | Array | object -
show-zero-badge v3.2.2 當(dāng) badge 為數(shù)字 0 時,是否展示徽標(biāo) boolean true

Tabs Events

事件名 說明 回調(diào)參數(shù)
click-tab v3.1.4 點擊標(biāo)簽時觸發(fā) { name: string | number, title: string, event: MouseEvent, disabled: boolean }
change 當(dāng)前激活的標(biāo)簽改變時觸發(fā) name: string | number, title: string
rendered 標(biāo)簽內(nèi)容首次渲染時觸發(fā)(僅在開啟延遲渲染后觸發(fā)) name: string | number, title: string
scroll 滾動時觸發(fā),僅在 sticky 模式下生效 { scrollTop: number, isFixed: boolean }
提示:click 和 disabled 事件已廢棄,請使用 click-tab 事件代替。

Tabs 方法

通過 ref 可以獲取到 Tabs 實例并調(diào)用實例方法,詳見組件實例方法。

方法名 說明 參數(shù) 返回值
resize 外層元素大小或組件顯示狀態(tài)變化時,可以調(diào)用此方法來觸發(fā)重繪 - -
scrollTo 滾動到指定的標(biāo)簽頁,在滾動導(dǎo)航模式下可用 name: string | number -

類型定義

組件導(dǎo)出以下類型定義:

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

?TabsInstance? 是組件實例的類型,用法如下:

import { ref } from 'vue';
import type { TabsInstance } from 'vant';

const tabsRef = ref<TabsInstance>();

tabsRef.value?.scrollTo(0);

Tabs Slots

名稱 說明
nav-left 標(biāo)簽欄左側(cè)內(nèi)容
nav-right 標(biāo)簽欄右側(cè)內(nèi)容
nav-bottom v3.1.1 標(biāo)簽欄下方內(nèi)容

Tab Slots

名稱 說明
default 標(biāo)簽頁內(nèi)容
title 自定義標(biāo)題

主題定制

樣式變量

組件提供了下列 CSS 變量,可用于自定義樣式,使用方法請參考 ConfigProvider 組件。

名稱 默認值 描述
--van-tab-text-color var(--van-gray-7) -
--van-tab-active-text-color var(--van-text-color) -
--van-tab-disabled-text-color var(--van-text-color-3) -
--van-tab-font-size var(--van-font-size-md) -
--van-tab-line-height var(--van-line-height-md) -
--van-tabs-default-color var(--van-primary-color) -
--van-tabs-line-height 44px -
--van-tabs-card-height 30px -
--van-tabs-nav-background var(--van-background-2) -
--van-tabs-bottom-bar-width 40px -
--van-tabs-bottom-bar-height 3px -
--van-tabs-bottom-bar-color var(--van-primary-color) -

常見問題

組件從隱藏狀態(tài)切換到顯示狀態(tài)時,底部條位置錯誤?

Tabs 組件在掛載時,會獲取自身的寬度,并計算出底部條的位置。如果組件一開始處于隱藏狀態(tài),則獲取到的寬度永遠為 0,因此無法展示底部條位置。

解決方法

方法一,如果是使用 ?v-show? 來控制組件展示的,則替換為 ?v-if? 即可解決此問題:

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

方法二,調(diào)用組件的 resize 方法來主動觸發(fā)重繪:

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


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號