Tab 标签页

介绍

选项卡组件,用于在不同的内容区域之间进行切换。

代码演示

基础用法

通过 v-model:active 绑定当前激活标签对应的索引值,默认情况下启用第一个标签。

<z-tabs v-model:active="active">
  <z-tab title="标签 1">内容 1</z-tab>
  <z-tab title="标签 2">内容 2</z-tab>
  <z-tab title="标签 3">内容 3</z-tab>
  <z-tab title="标签 4">内容 4</z-tab>
</z-tabs>
import { ref } from 'vue';
const active = ref(0);

通过名称匹配

在标签指定 name 属性的情况下,v-model:active 的值为当前标签的 name(此时无法通过索引值来匹配标签)。

<z-tabs v-model:active="activeName">
  <z-tab title="标签 1" name="a">内容 1</z-tab>
  <z-tab title="标签 2" name="b">内容 2</z-tab>
  <z-tab title="标签 3" name="c">内容 3</z-tab>
</z-tabs>
import { ref } from 'vue';
const activeName = ref('b');

标签栏滚动

标签数量超过 5 个时,标签栏可以在水平方向上滚动,切换时会自动将当前标签居中。

<z-tabs v-model:active="active">
  <z-tab v-for="index in 8" :title="'标签 ' + index">
    内容 {{ index }}
  </z-tab>
</z-tabs>

禁用标签

设置 disabled 属性即可禁用标签。

<z-tabs v-model:active="active">
  <z-tab title="标签 1">内容 1</z-tab>
  <z-tab title="标签 2" disabled>内容 2</z-tab>
  <z-tab title="标签 3">内容 3</z-tab>
</z-tabs>

样式风格

Tab 支持两种样式风格:linecard,默认为 line 样式,可以通过 type 属性切换样式风格。

<z-tabs v-model:active="active" type="card">
  <z-tab title="标签 1">内容 1</z-tab>
  <z-tab title="标签 2">内容 2</z-tab>
  <z-tab title="标签 3">内容 3</z-tab>
</z-tabs>

点击事件

点击标签页时,会触发 click-tab 事件。

<z-tabs v-model:active="active" @click-tab="onClickTab">
  <z-tab title="标签 1">内容 1</z-tab>
  <z-tab title="标签 2">内容 2</z-tab>
</z-tabs>
import { ref } from 'vue';
import { useToast } from '../../uni_modules/zebra-ui'
const toast = useToast()
const onClickTab = ({ title }: any) => toast.showToast(title)

粘性布局

通过 sticky 属性可以开启粘性布局,粘性布局下,标签页滚动到顶部时会自动吸顶。

<z-tabs v-model:active="active" sticky>
  <z-tab v-for="index in 4" :title="'选项 ' + index">
    内容 {{ index }}
  </z-tab>
</z-tabs>

Tips: 如果页面顶部有其他内容,可以通过 offset-top 属性设置吸顶时与顶部的距离。自定义导航栏需声明custom-navbar属性。

收缩布局

通过 shrink 属性可以开启收缩布局,开启后,所有的标签会向左侧收缩对齐。

<z-tabs v-model:active="active" shrink>
  <z-tab v-for="index in 4" :title="'选项 ' + index">
    内容 {{ index }}
  </z-tab>
</z-tabs>

自定义标签

通过 title 插槽可以自定义标签内容。

<z-tabs v-model:active="active">
  <z-tab v-for="index in 2">
    <template #title> <z-icon name="star" />选项 </template>
    内容 {{ index }}
  </z-tab>
</z-tabs>

切换动画

通过 animated 属性可以开启切换标签内容时的转场动画。

<z-tabs v-model:active="active" animated>
  <z-tab v-for="index in 4" :title="'选项 ' + index">
    内容 {{ index }}
  </z-tab>
</z-tabs>

滑动切换

通过 swipeable 属性可以开启滑动切换标签页。

<z-tabs v-model:active="active" swipeable>
  <z-tab v-for="index in 4" :title="'选项 ' + index">
    内容 {{ index }}
  </z-tab>
</z-tabs>

滚动导航

通过 scrollspy 属性可以开启滚动导航模式,该模式下,内容将会平铺展示。

<z-tabs v-model:active="activeScrollspy" scrollspy>
  <view style="height: 1000rpx">
    <z-tab
      v-for="(item, index) in 18"
      :key="index"
      :title="`标签 ${item}`"
    >
      <view class="demo-tab-item"> 内容{{ item }} </view>
    </z-tab>
  </view>
</z-tabs>

异步切换

通过 before-change 属性可以在切换标签前执行特定的逻辑。

<z-tabs v-model:active="activeBefore" :before-change="beforeChange">
  <z-tab
    v-for="(item, index) in 4"
    :key="index"
    :title="`标签 ${item}`"
  >
    <view class="demo-tab-item"> 内容{{ item }} </view>
  </z-tab>
</z-tabs>
const beforeChange = (index: any) => {
  if (index === 1) {
    return false
  }
  return new Promise((resolve) => {
    resolve(index !== 3)
  })
}

Tips: 通过手势滑动不会触发 before-change 属性。

隐藏标题栏

通过将 showHeader 属性设置为 false,可以不渲染 Tabs 的标题栏。在这种情况下,你可以通过一些自定义组件来控制 Tabs 的 active 属性。

<z-tabs v-model:active="active" :show-header="false">
  <z-tab v-for="index in 4"> 内容 {{ index }} </z-tab>
</z-tabs>

API

Tabs Props

参数说明类型默认值
v-model:active绑定当前选中标签的标识符number | string0
type样式风格类型,可选值为 cardstringline
color标签主题色string#1989fa
background标签栏背景色stringwhite
duration动画时间,单位秒,设置为 0 可以禁用动画number | string0.3
line-width底部条宽度,默认单位 pxnumber | string80rpx
line-height底部条高度,默认单位 pxnumber | string6rpx
animated是否开启切换标签内容时的转场动画booleanfalse
border是否显示标签栏外边框,仅在 type="line" 时有效booleanfalse
ellipsis是否省略过长的标题文字booleantrue
sticky是否使用粘性布局booleanfalse
shrink是否开启左侧收缩布局booleanfalse
swipeable是否开启手势左右滑动切换booleanfalse
scrollspy是否开启滚动导航booleanfalse
show-header是否显示标题栏booleantrue
offset-top粘性布局下吸顶时与顶部的距离,支持 rpx 单位,默认 pxnumber | string0
swipe-threshold滚动阈值,标签数量超过阈值且总宽度超过标签栏宽度时开始横向滚动number | string5
title-active-color标题选中态颜色string-
title-inactive-color标题默认态颜色string-
before-change切换标签前的回调函数,返回 false 可阻止切换,支持返回 Promise(name: number | string) => boolean | Promise<boolean>-

Tab Props

参数说明类型默认值
title标题string-
disabled是否禁用标签booleanfalse
dot是否在标题右上角显示小红点booleanfalse
badge图标右上角徽标的内容number | string-
name标签名称,作为匹配的标识符number | string标签的索引值
title-style自定义标题样式string | Array | object-
title-class自定义标题类名string | Array | object-
show-zero-badge当 badge 为数字 0 时,是否展示徽标booleantrue

Tabs Events

事件名说明回调参数
click-tab点击标签时触发{ name: string | number, title: string, event: MouseEvent, disabled: boolean }
change当前激活的标签改变时触发name: string | number, title: string
scroll滚动时触发,仅在 sticky 模式下生效{ scrollTop: number, isFixed: boolean }

Tabs 方法

通过 ref 可以获取到 Tabs 实例并调用实例方法。

方法名说明参数返回值
resize外层元素大小或组件显示状态变化时,可以调用此方法来触发重绘--
scrollTo滚动到指定的标签页,在滚动导航模式下可用name: string | number-

Tabs Slots

名称说明
nav-left标签栏左侧内容
nav-right标签栏右侧内容
nav-bottom标签栏下方内容

Tab Slots

名称说明
default标签页内容
title自定义标题

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--z-tab-text-colorvar(--z-gray-7)-
--z-tab-active-text-colorvar(--z-text-color)-
--z-tab-disabled-text-colorvar(--z-text-color-3)-
--z-tab-font-sizevar(--z-font-size-md)-
--z-tab-line-heightvar(--z-line-height-md)-
--z-tabs-default-colorvar(--z-primary-color)-
--z-tabs-line-height88rpx-
--z-tabs-card-height60rpx-
--z-tabs-nav-backgroundvar(--z-background-2)-
--z-tabs-bottom-bar-width80rpx-
--z-tabs-bottom-bar-height6rpx-
--z-tabs-bottom-bar-colorvar(--z-primary-color)-