Skip to content

Tabbar 标签栏

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

基础用法

v-model 为绑定值,表示选中标签的索引值或者名称。

html
<wui-tabbar v-model="tabbar">
  <wui-tabbar-item title="首页" icon="home"></wui-tabbar-item>
  <wui-tabbar-item title="分类" icon="cart"></wui-tabbar-item>
  <wui-tabbar-item title="我的" icon="user"></wui-tabbar-item>
</wui-tabbar>
typescript
import { ref } from 'vue'

const tabbar = ref(1)

通过名称匹配

通过设置 name 属性,可以通过名称匹配选中标签。

html
<wui-tabbar v-model="tabbar">
  <wui-tabbar-item name="home" title="首页" icon="home"></wui-tabbar-item>
  <wui-tabbar-item name="cart" title="分类" icon="cart"></wui-tabbar-item>
  <wui-tabbar-item name="setting" title="设置" icon="setting"></wui-tabbar-item>
  <wui-tabbar-item name="user" title="我的" icon="user"></wui-tabbar-item>
</wui-tabbar>
typescript
import { ref } from 'vue'

const tabbar = ref('home')

徽标提示

通过设置 value 属性,可以显示徽标提示,而设置 is-dot 属性后,会在图标右上角展示一个小红点。

html
<wui-tabbar v-model="tabbar">
  <wui-tabbar-item is-dot :value="2" title="点状" icon="home"></wui-tabbar-item>
  <wui-tabbar-item :value="2" icon="cart" title="分类"></wui-tabbar-item>
  <wui-tabbar-item :value="30" title="我的" icon="user"></wui-tabbar-item>
  <wui-tabbar-item :value="200" title="最大值" icon="user"></wui-tabbar-item>
</wui-tabbar>
typescript
import { ref } from 'vue'

const tabbar = ref(1)

悬浮标签栏

通过设置 shape 属性为 round,可以将标签栏设置为悬浮样式。

html
<wui-tabbar shape="round" v-model="tabbar">
  <wui-tabbar-item title="首页" is-dot :value="2" icon="home"></wui-tabbar-item>
  <wui-tabbar-item title="分类" :value="2" icon="cart"></wui-tabbar-item>
  <wui-tabbar-item title="相册" :value="30" icon="photo"></wui-tabbar-item>
  <wui-tabbar-item title="我的" :value="200" icon="user"></wui-tabbar-item>
</wui-tabbar>
typescript
import { ref } from 'vue'

const tabbar = ref(1)

自定义图标

通过使用 <template #icon> 可以自定义标签页的图标。

html
<wui-tabbar v-model="tabbar">
  <wui-tabbar-item :value="2" title="首页" icon="home"></wui-tabbar-item>
  <wui-tabbar-item :value="2" icon="cart" title="分类">
    <template #icon>
      <wui-img round height="40rpx" width="40rpx" src="https://registry.npmmirror.com/elegant-wui-uni-assets/*/files/panda.jpg"></wui-img>
    </template>
  </wui-tabbar-item>
  <wui-tabbar-item :value="3" title="我的" icon="user"></wui-tabbar-item>
</wui-tabbar>
typescript
import { ref } from 'vue'

const tabbar = ref(1)

自定义颜色

通过设置 active-colorinactive-color 属性,可以自定义激活和未激活标签的颜色。

html
<wui-tabbar v-model="tabbar" active-color="#ee0a24" inactive-color="#7d7e80">
  <wui-tabbar-item is-dot :value="2" title="点状" icon="home"></wui-tabbar-item>
  <wui-tabbar-item :value="2" icon="cart" title="分类"></wui-tabbar-item>
  <wui-tabbar-item :value="30" title="我的" icon="user"></wui-tabbar-item>
  <wui-tabbar-item :value="200" title="最大值" icon="photo"></wui-tabbar-item>
  <wui-tabbar-item :value="10" title="客服" icon="chat"></wui-tabbar-item>
</wui-tabbar>
typescript
import { ref } from 'vue'

const tabbar = ref(1)

监听切换事件

通过监听 change 事件,可以获取选中标签的值。

html
<wui-tabbar v-model="tabbar" @change="handleChange" active-color="#ee0a24" inactive-color="#7d7e80">
  <wui-tabbar-item title="首页" icon="home"></wui-tabbar-item>
  <wui-tabbar-item title="分类" icon="cart"></wui-tabbar-item>
  <wui-tabbar-item title="我的" icon="user"></wui-tabbar-item>
  <wui-tabbar-item title="相册" icon="photo"></wui-tabbar-item>
  <wui-tabbar-item title="客服" icon="chat"></wui-tabbar-item>
</wui-tabbar>
typescript
import { ref } from 'vue'

const tabbar = ref(1)

function handleChange({ value }: { value: string }) {
  show(`选中标签:${value}`)
}

固定底部

通过设置 fixed 属性,可以将标签栏固定在底部;通过设置 placeholder 属性,可以在固定在底部时在标签位置生成一个等高的占位元素。

html
<wui-tabbar fixed v-model="tabbar" bordered safeAreaInsetBottom placeholder>
  <wui-tabbar-item :value="2" is-dot title="首页" icon="home"></wui-tabbar-item>
  <wui-tabbar-item title="分类" icon="cart"></wui-tabbar-item>
  <wui-tabbar-item title="我的" icon="user"></wui-tabbar-item>
  <wui-tabbar-item :value="200" title="相册" icon="photo"></wui-tabbar-item>
  <wui-tabbar-item :value="10" title="客服" icon="chat"></wui-tabbar-item>
</wui-tabbar>
typescript
import { ref } from 'vue'

const tabbar = ref(1)

Attributes

参数说明类型可选值默认值最低版本
model-value / v-model选中标签的索引值或者名称number / string-0-
fixed是否固定在底部boolean-false-
safeAreaInsetBottom是否设置底部安全距离(iPhone X 类型的机型)boolean-false-
bordered是否显示顶部边框boolean-true-
shape标签栏的形状TabbarShape'default' / 'round''default'-
activeColor激活标签的颜色string---
inactiveColor未激活标签的颜色string---
placeholder固定在底部时,是否在标签位置生成一个等高的占位元素boolean-false-
zIndextabbar 组件的层级number-500-

Events

事件名称说明参数最低版本
changetabbar 标签切换时触发{ value }-

外部样式类

类名说明最低版本
custom-class根节点样式类-
custom-style根节点样式-

TabbarItem Attributes

参数说明类型可选值默认值最低版本
title标签页的标题string---
name唯一标识符string / number---
icon图标string---
value徽标显示值number / string---
isDot是否点状徽标boolean-false-
max徽标最大值number-99-
badge-props自定义徽标的属性,传入的对象会被透传给 Badge 组件的 propsBadgeProps---

TabbarItem Slots

name说明参数最低版本
icon自定义图标active: boolean-

TabbarItem 外部样式类

类名说明最低版本
custom-class根节点样式类-
custom-style根节点样式-

源代码

文档
组件

Released under the MIT License.

Released under the MIT License.