Skip to content

Tabs 标签页

分隔内容上有关联但属于不同类别的数据集合。

基础用法

卡片风格的标签

标签位置的设置

标签栏滚动

粘性布局

Tips: 如果页面顶部有其他内容,可以通过 offset-top 属性设置吸顶时与顶部的距离。

切换动画

滑动切换

滚动导航

自定义标签页的内容

动态增减标签页

自定义增加标签页触发器

异步切换

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

API

Tabs Props

参数说明类型默认值
v-model:active绑定当前选中标签的标识符number | string0
type样式风格类型,可选值为 cardstringline
tab-position选项卡所在位置 right/bottom/lefstringtop
color标签主题色string#1989fa
border是否显示标签栏外边框,仅在 type="line" 时有效booleanfalse
sticky是否使用粘性布局booleanfalse
shrink是否开启左侧收缩布局booleanfalse
duration动画时间,单位秒,设置为 0 可以禁用动画number | string0.3
animated是否开启切换标签内容时的转场动画(开启该属性后,内容区如果有粘性布局将会不达预期)booleanfalse
ellipsis是否省略过长的标题文字(仅在 shrinkfalsetab 数量小于等于 swipe-threshold 时生效)booleantrue
swipeable是否开启手势左右滑动切换(开启该属性后,内容区如果有粘性布局将会不达预期)booleanfalse
scrollspy是否开启滚动导航booleanfalse
offset-top粘性布局下吸顶时与顶部的距离,支持 px vw vh rem 单位,默认 pxnumber | string0
background标签栏背景色stringwhite
lazy-render是否开启延迟渲染(首次切换到标签时才触发内容渲染)booleantrue
line-width底部条宽度,默认单位 pxnumber | string40px
line-height底部条高度,默认单位 pxnumber | string3px
before-change切换标签前的回调函数,返回 false 可阻止切换,支持返回 Promise(name: number | string) => boolean | Promise\<boolean\>-
swipe-threshold滚动阈值,标签数量超过阈值且总宽度超过标签栏宽度时开始横向滚动(仅在 shrinkfalseellipsistrue 时生效)number | string5
title-active-color标题选中态颜色string-
title-inactive-color标题默认态颜色string-
closable标签是否可关闭booleanfalse
addable标签是否可增加booleanfalse
editable标签是否同时可增加和关闭booleanfalse

Tabs Events

事件名说明回调参数
click-tab点击标签时触发{ name: string | number, title: string, event: MouseEvent, disabled: boolean }
change当前激活的标签改变时触发name: string | number, title: string
rendered标签内容首次渲染时触发(仅在开启延迟渲染后触发)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 Props

参数说明类型默认值
title标题string-
disabled是否禁用标签booleanfalse
dot是否在标题右上角显示小红点booleanfalse
badge图标右上角徽标的内容(dotfasle 时生效)number | string-
name标签名称,作为匹配的标识符number | string标签的索引值
url点击后跳转的链接地址string-
to点击后跳转的目标路由对象,等同于 Vue Router 的 to 属性string | object-
replace是否在跳转时替换当前页面历史booleanfalse
title-style自定义标题样式string | Array | object-
title-class自定义标题类名string | Array | object-
closable标签是否可关闭booleanfalse
show-zero-badge当 badge 为数字 0 时,是否展示徽标booleantrue

Tab Slots

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

类型定义

组件导出以下类型定义:

ts
import type { TabProps, TabsType, TabsProps, TabsInstance } from 'ryxon'

TabsInstance 是组件实例的类型,用法如下:

ts
import { ref } from 'vue'
import type { TabsInstance } from 'ryxon'

const tabsRef = ref<TabsInstance>()

tabsRef.value?.scrollTo(0)

主题定制

样式变量

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

名称默认值描述
--r-tab-text-colorvar(--r-gray-7)-
--r-tab-active-text-colorvar(--r-text-color)-
--r-tab-disabled-text-colorvar(--r-text-color-3)-
--r-tab-font-sizevar(--r-font-size-md)-
--r-tab-line-heightvar(--r-line-height-md)-
--r-tabs-default-colorvar(--r-primary-color)-
--r-tabs-line-height44px-
--r-tabs-card-height30px-
--r-tabs-nav-backgroundvar(--r-background-2)-
--r-tabs-bottom-bar-width40px-
--r-tabs-bottom-bar-height3px-
--r-tabs-bottom-bar-colorvar(--r-primary-color)-

常见问题

组件从隐藏状态切换到显示状态时,底部条位置错误?

Tabs 组件在挂载时,会获取自身的宽度,并计算出底部条的位置。如果组件一开始处于隐藏状态,则获取到的宽度永远为 0,因此无法展示底部条位置。

解决方法

方法一,如果是使用 v-show 来控制组件展示的,则替换为 v-if 即可解决此问题:

html
<!-- Before -->
<r-tabs v-show="show" />
<!-- After -->
<r-tabs v-if="show" />

方法二,调用组件的 resize 方法来主动触发重绘:

html
<r-tabs v-show="show" ref="tabs" />
js
this.$refs.tabs.resize()

Tabs 开启 swipeable 或 animated 属性后,内容区元素的 sticky 功能将不达预期

Tabs 开启 swipeableanimated 属性后,内容区将被带有 transform 属性的元素包裹,此时如果内容区的元素开启了 sticky 功能,那么该功能生效了,但显示位置将不达预期。比如下面的代码:

html
<r-tabs v-model:active="active" swipeable>
  <r-tab>
    <r-sticky>
      <r-button>sticky button</r-button>
    </r-sticky>
  </r-tab>
</r-tabs>

这是因为 transform 元素内部的 fixed 定位会相对于该元素进行计算,而不是相对于整个文档,从而导致布局异常。

Released under the MIT License.