vant/src/tab

Tab

Intro

Used to switch between different content areas.

Install

Register component globally via app.use, refer to Component Registration for more registration ways.

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

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

Usage

Basic Usage

The first tab is actived by default, you can set v-model:active to active specified tab.

<van-tabs v-model:active="active">
  <van-tab v-for="index in 4" :title="'tab' + index">
    content of tab {{ index }}
  </van-tab>
</van-tabs>

import { ref } from 'vue';

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

Match By Name

<van-tabs v-model:active="activeName">
  <van-tab title="tab 1" name="a">content of tab 1</van-tab>
  <van-tab title="tab 2" name="b">content of tab 2</van-tab>
  <van-tab title="tab 3" name="c">content of tab 3</van-tab>
</van-tabs>

import { ref } from 'vue';

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

Swipe Tabs

By default more than 5 tabs, you can scroll through the tabs. You can set swipe-threshold attribute to customize threshold number.

<van-tabs>
  <van-tab v-for="index in 8" :title="'tab' + index">
    content of tab {{ index }}
  </van-tab>
</van-tabs>

Disabled Tab

You can set disabled attribute on the corresponding van-tab.

<van-tabs @disabled="onClickDisabled">
  <van-tab v-for="index in 3" :title="'tab' + index" :disabled="index === 2">
    content of tab {{ index }}
  </van-tab>
</van-tabs>

import { Toast } from 'vant';

export default {
  setup() {
    const onClickDisabled = (name, title) => Toast(`${name} is disabled`);
    return {
      onClickDisabled,
    };
  },
};

Card Style

Tabs styled as cards.

<van-tabs type="card">
  <van-tab v-for="index in 3" :title="'tab' + index">
    content of tab {{ index }}
  </van-tab>
</van-tabs>

Click Event

<van-tabs @click="onClick">
  <van-tab v-for="index in 2" :title="'tab' + index">
    content of tab {{ index }}
  </van-tab>
</van-tabs>

import { Toast } from 'vant';

export default {
  setup() {
    const onClick = (name, title) => Toast(title);
    return {
      onClick,
    };
  },
};

Sticky

In sticky mode, the tab will be fixed to top when scroll to top.

<van-tabs v-model:active="active" sticky>
  <van-tab v-for="index in 4" :title="'tab ' + index">
    content {{ index }}
  </van-tab>
</van-tabs>

Custom title

Use title slot to custom tab title.

<van-tabs v-model:active="active">
  <van-tab v-for="index in 2" :key="index">
    <template #title> <van-icon name="more-o" />tab </template>
    content {{ index }}
  </van-tab>
</van-tabs>

Switch Animation

Use animated props to change tabs with animation.

<van-tabs v-model:active="active" animated>
  <van-tab v-for="index in 4" :title="'tab ' + index">
    content {{ index }}
  </van-tab>
</van-tabs>

Swipeable

In swipeable mode, you can switch tabs with swipe gestrue in the content.

<van-tabs v-model:active="active" swipeable>
  <van-tab v-for="index in 4" :title="'tab ' + index">
    content {{ index }}
  </van-tab>
</van-tabs>

Scrollspy

In scrollspy mode, the list of content will be tiled.

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

Before Change

<van-tabs :before-change="beforeChange">
  <van-tab v-for="index in 4" :title="'tab ' + index">
    content {{ index }}
  </van-tab>
</van-tabs>

export default {
  setup() {
    const beforeChange = (index) => {
      // prevent change
      if (index === 1) {
        return false;
      }

      // async
      return new Promise((resolve) => {
        resolve(index !== 3);
      });
    };

    return {
      beforeChange,
    };
  },
};

API

Tabs Props

Attribute	Description	Type	Default
v-model:active	Index of active tab	number | string	0
type	Can be set to line card	string	line
color	Tab color	string	#ee0a24
background	Background color	string	white
duration	Toggle tab's animation time	number | string	0.3
line-width	Width of tab line	number | string	40px
line-height	Height of tab line	number | string	3px
animated	Whether to change tabs with animation	boolean	false
border	Whether to show border when type="line"	boolean	false
ellipsis	Whether to ellipsis too long title	boolean	true
sticky	Whether to use sticky mode	boolean	false
swipeable	Whether to enable gestures to slide left and right	boolean	false
lazy-render	Whether to enable tab content lazy render	boolean	true
scrollspy	Whether to use scrollspy mode	boolean	false
offset-top	Sticky offset top , supports px vw vh rem unit, default px	number | string	0
swipe-threshold	Set swipe tabs threshold	number | string	5
title-active-color	Title active color	string	-
title-inactive-color	Title inactive color	string	-
before-change	Callback function before changing tabs，return false to prevent change，support return Promise	(name) => boolean | Promise	-

Tab Props

Attribute	Description	Type	Default
title	Title	string	-
disabled	Whether to disable tab	boolean	false
dot	Whether to show red dot on the title	boolean	false
badge	Content of the badge on the title	number | string	-
name	Identifier	number | string	Index of tab
url	Link	string	-
to	Target route of the link, same as to of vue-router	string | object	-
replace	If true, the navigation will not leave a history record	boolean	false
title-style	Custom title style	string | Array | object	-
title-class	Custom title class name	string | Array | object	-

Tabs Events

Event	Description	Arguments
click	Emitted when a tab is clicked	name: string | number, title: string
change	Emitted when active tab changed	name: string | number, title: string
disabled	Emitted when a disabled tab is clicked	name: string | number, title: string
rendered	Emitted when content first rendered in lazy-render mode	name: string | number, title: string
scroll	Emitted when tab scrolling in sticky mode	{ scrollTop: number, isFixed: boolean }

Tabs Methods

Use ref to get Tabs instance and call instance methods.

Name	Description	Attribute	Return value
resize	Resize Tabs when container element resized or visibility changed	-	-
scrollTo	Go to specified tab in scrollspy mode	name: string | number	-

Tabs Slots

Name	Description
nav-left	Custom nav left content
nav-right	Custom nav right content

Tab Slots

Name	Description
default	Content of tab
title	Custom tab title

Less Variables

How to use: Custom Theme.

Name	Default Value	Description
@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-height	44px	-
@tabs-card-height	30px	-
@tabs-nav-background-color	@white	-
@tabs-bottom-bar-width	40px	-
@tabs-bottom-bar-height	3px	-
@tabs-bottom-bar-color	@tabs-default-color	-