Skip to content

Tab 标签页

基本用法

v-model 为绑定值,可以为 number 类型(选中的 tab 的下标)和 string 类型(标签名)。

提示

v-modelnumber类型时,wd-tab可以不必设置name。同时如果 value 超出了 tab 数量,会用 0 自动兜底。

html
<wd-tabs v-model="tab">
  <block v-for="item in 4" :key="item">
    <wd-tab :title="`标签${item}`">
      <view class="content">内容{{ item}}</view>
    </wd-tab>
  </block>
</wd-tabs>
typescript
const tab = ref<number>(0)
scss
.content {
  line-height: 120px;
  text-align: center;
}

name 匹配

wd-tab设置name作为唯一标识。

html
<wd-tabs v-model="tab">
  <block v-for="item in tabs" :key="item">
    <wd-tab :title="`${item}`" :name="item">
      <view class="content">内容{{ item }}</view>
    </wd-tab>
  </block>
</wd-tabs>
typescript
const tabs = ref(['这', '是', '一', '个', '例子'])
const tab = ref('例子')
scss
.content {
  line-height: 120px;
  text-align: center;
}

使用徽标1.4.0

使用bage-props设置徽标属性,可以参考Badge 组件的 props

html
<wd-tabs v-model="tabWithBadge" @change="handleChange">
  <wd-tab v-for="(item, index) in tabsWithBadge" :key="index" :title="`${item.title}`" :badge-props="item.badgeProps">
    <view class="content">{{ item.title }}徽标</view>
  </wd-tab>
</wd-tabs>
typescript
const tabWithBadge = ref(0)
const tabsWithBadge = ref([
  {
    title: '普通数值',
    badgeProps: {
      modelValue: 10,
      right: '-8px'
    }
  },
  {
    title: '最大值',
    badgeProps: {
      modelValue: 100,
      max: 99,
      right: '-8px'
    }
  },
  {
    title: '点状',
    badgeProps: {
      isDot: true,
      right: '-8px',
      showZero: true
    }
  }
])

自动调整底部条宽度

设置 auto-line-width 属性,自动调整底部条宽度为文本内容宽度。

html
<wd-tabs v-model="tab" @change="handleChange" auto-line-width>
  <block v-for="item in tabs" :key="item">
    <wd-tab :title="`${item}`" :name="item">
      <view class="content">内容{{ tab }}</view>
    </wd-tab>
  </block>
</wd-tabs>
typescript
const tabs = ref(['Wot', 'Design', 'Uni'])
const tab = ref('Design')

粘性布局

设置 sticky 属性,使用粘性布局。可以设置 offset-top 属性,当距离窗口顶部多少像素时,固定标签头。在H5端使用自定义导航栏时需要参考sticky 的吸顶距离进行配置。

html
<wd-tabs v-model="tab" sticky>
  <block v-for="item in 4" :key="item">
    <wd-tab :title="`标签${item}`">
      <view class="content">内容{{ item}}</view>
    </wd-tab>
  </block>
</wd-tabs>

禁用 Tab

wd-tab 上设置 disabled 属性,禁用某个页签。

html
<wd-tabs v-model="tab">
  <block v-for="item in 4" :key="item">
    <wd-tab :title="`标签${item}`" :disabled="item === 1">
      <view class="content">内容{{ item }}</view>
    </wd-tab>
  </block>
</wd-tabs>

点击事件

监听页签的点击事件.

html
<wd-tabs v-model="tab" @click="handleClick">
  <block v-for="item in 4" :key="item">
    <wd-tab :title="`标签${item}`">
      <view class="content">内容{{ item }}</view>
    </wd-tab>
  </block>
</wd-tabs>

手势滑动

设置 swipeable 属性,支持手势滑动。

html
<wd-tabs v-model="tab" swipeable>
  <block v-for="item in 4" :key="item">
    <wd-tab :title="`标签${item}`">
      <view class="content">内容{{ item }}</view>
    </wd-tab>
  </block>
</wd-tabs>

切换动画

设置 animated 属性,开启切换标签内容时的过渡动画。

html
<wd-tabs v-model="tab" animated>
  <block v-for="item in 4" :key="item">
    <wd-tab :title="`标签${item}`">
      <view class="content">内容{{ item }}</view>
    </wd-tab>
  </block>
</wd-tabs>

左对齐超出即可滚动 1.4.0

slidable设置为always时,所有的标签会向左侧收缩对齐,超出即可滑动。

html
<wd-tabs v-model="tab" slidable="always">
  <block v-for="item in 5" :key="item">
    <wd-tab :title="`超大标签${item}`">
      <view class="content">内容{{ item }}</view>
    </wd-tab>
  </block>
</wd-tabs>

标签页在标签数大于等于 6 个时,可以滑动;当标签数大于等于 10 个时,将会显示导航地图,便于快速定位到某个标签。可以通过设置 slidable-num 修改可滑动的数量阈值;设置 map-num 修改显示导航地图的阈值。slidable设置为always时,所有的标签会向左侧收缩对齐,超出即可滑动。

在弹出框中使用

微信小程序端,在弹出框中使用本组件时,需要调用 updateLineStyle 方法更新激活项样式,参见常见问题

html
<wd-button @click="handleClick">打开弹窗</wd-button>
<wd-popup v-model="showPopup" position="bottom" @after-enter="handlePopupShow" closable custom-style="height: 200px;padding: 0 24rpx;">
  <view class="title">在弹出框中使用</view>
  <wd-tabs v-model="tab" ref="tabsRef">
    <wd-tab v-for="item in tabs" :key="item" :title="`${item}`" :name="item">
      <view class="content">内容{{ tab }}</view>
    </wd-tab>
  </wd-tabs>
</wd-popup>
ts
const tab = ref<number>(3)
const tabs = ref(['这', '是', '一', '个', '例子'])

const showPopup = ref(false) // 控制popup显示
const tabsRef = ref<TabsInstance>() // 获取分段器实例
/**
 * 点击按钮打开popup
 */
function handleOpenClick() {
  showPopup.value = true
}
/**
 * popup打开后更新分段器样式
 */
function handlePopupShow() {
  tabsRef.value?.updateLineStyle(false)
}
css
.title {
  display: flex;
  font-size: 32rpx;
  align-items: center;
  justify-content: center;
  padding: 24rpx 0;
}

Tabs Attributes

参数说明类型可选值默认值最低版本
v-model绑定值string / number---
slidable-num可滑动的标签数阈值,slidable设置为auto时生效number-6-
map-num显示导航地图的标签数阈值number-10-
map-title导航地图标题string--1.4.0
sticky粘性布局boolean-false-
offset-top粘性布局时距离窗口顶部距离number-0-
swipeable开启手势滑动boolean-false-
autoLineWidth底部条宽度跟随文字,指定lineWidth时此选项不生效boolean-false1.4.0
lineWidth底部条宽度,单位像素number-19-
lineHeight底部条高度,单位像素number-3-
color文字颜色string---
inactiveColor非活动标签文字颜色string---
animated是否开启切换标签内容时的转场动画boolean-false-
duration切换动画过渡时间,单位毫秒number-300-
slidable是否开启滚动导航TabsSlidablealwaysauto1.4.0
badge-props自定义徽标的属性,传入的对象会被透传给 Badge 组件的 propsBadgeProps--1.4.0

Tab Attributes

参数说明类型可选值默认值最低版本
name标签页名称string---
title标题string---
disabled禁用boolean-false-
lazy延迟渲染,默认开启,开启animated后此选项始终为falseboolean-true1.4.0

Tabs Events

事件名称说明参数最低版本
change绑定值变化时触发event = { index, name },index 为 tab 下标,name 为 tab 绑定的值-
click点击标题时触发event = { index, name },index 为 tab 下标,name 为 tab 绑定的值-
disabled点击禁用的标题时触发event = { index, name },index 为 tab 下标,name 为 tab 绑定的值-

Methods

对外暴露函数

事件名称说明参数最低版本
setActive设置激活项,参数分别为:value 激活值,init 是否已初始化 ,setScroll 是否设置 scroll-view 滚动(value: number | string, init: boolean, setScroll: boolean) => void-
scrollIntoView使选中项滚动到可视区域--
updateLineStyle更新激活项边框线样式,参数animation用于是否开启动画,默认开启(animation: boolean) => void-

外部样式类

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

源代码

文档
组件

Released under the MIT License.

Released under the MIT License.