# Tabbar
### Install
```js
import { createApp } from 'vue';
import { Tabbar, TabbarItem } from 'vant';
const app = createApp();
app.use(Tabbar);
app.use(TabbarItem);
```
## Usage
### Basic Usage
```html
Tab
Tab
Tab
Tab
```
```js
import { ref } from 'vue';
export default {
setup() {
const active = ref(0);
return { active };
},
};
```
### Match by name
```html
Tab
Tab
Tab
Tab
```
```js
import { ref } from 'vue';
export default {
setup() {
const active = ref('home');
return { active };
},
};
```
### Show Badge
```html
Tab
Tab
Tab
Tab
```
### Custom Icon
Use `icon` slot to custom icon.
```html
Custom
Tab
Tab
```
```js
import { ref } from 'vue';
export default {
setup() {
const active = ref(0);
const icon = {
active: 'https://img01.yzcdn.cn/vant/user-active.png',
inactive: 'https://img01.yzcdn.cn/vant/user-inactive.png',
};
return {
icon,
active,
};
},
};
```
### Custom Color
```html
Tab
Tab
Tab
Tab
```
### Change Event
```html
Tab 1
Tab 2
Tab 3
Tab 4
```
```js
import { ref } from 'vue';
import { Toast } from 'vant';
export default {
setup() {
const active = ref(0);
const onChange = (index) => Toast(`Tab ${index}`);
return {
icon,
onChange,
};
},
};
```
### Route Mode
```html
Tab
Tab
```
## API
### Tabbar Props
| Attribute | Description | Type | Default |
| --- | --- | --- | --- |
| v-model | Identifier of current tab | _number \| string_ | `0` |
| fixed | Whether to fixed bottom | _boolean_ | `true` |
| border | Whether to show border | _boolean_ | `true` |
| z-index | Z-index | _number \| string_ | `1` |
| active-color | Color of active tab item | _string_ | `#1989fa` |
| inactive-color | Color of inactive tab item | _string_ | `#7d7e80` |
| route | Whether to enable route mode | _boolean_ | `false` |
| placeholder | Whether to generage a placeholder element when fixed | _boolean_ | `false` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `false` |
| before-change | Callback function before changing tabs,return `false` to prevent change,support return Promise | _(name) => boolean \| Promise_ | - |
### Tabbar Events
| Event | Description | Arguments |
| ------ | -------------------------------- | ---------------------------- |
| change | Emitted when changing active tab | active: index of current tab |
### TabbarItem Props
| Attribute | Description | Type | Default |
| --- | --- | --- | --- |
| name | Identifier | _number \| string_ | Item index |
| icon | Icon name | _string_ | - |
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
| dot | Whether to show red dot | _boolean_ | - |
| badge | Content of the badge | _number \| string_ | `''` |
| 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` |
### TabbarItem Slots
| Name | Description | SlotProps |
| ---- | ----------- | --------- |
| icon | Custom icon | active |
### Less Variables
How to use: [Custom Theme](#/en-US/theme).
| Name | Default Value | Description |
| --- | --- | --- |
| @tabbar-height | `50px` | - |
| @tabbar-z-index | `1` | - |
| @tabbar-background-color | `@white` | - |
| @tabbar-item-font-size | `@font-size-sm` | - |
| @tabbar-item-text-color | `@gray-7` | - |
| @tabbar-item-active-color | `@blue` | - |
| @tabbar-item-active-background-color | `@tabbar-background-color` | - |
| @tabbar-item-line-height | `1` | - |
| @tabbar-item-icon-size | `22px` | - |
| @tabbar-item-margin-bottom | `4px` | - |