更新记录

1.1.0(2022-09-27)

  • 优化左右滑动切换

1.0.9(2022-09-17)

  • 增加滚动导航scrollspy
  • 增加before-change ,用于切换标签前的回调函数
  • 增加no-render-conent,可使用该属性关闭标签内容的渲染

1.0.8(2022-09-14)

  • 支持vue3
  • 支持nvue
  • 增加tab-click-scroll-top,用于标签标题点击页面回滚到顶部
查看更多

平台兼容性

Vue2 Vue3
App 快应用 微信小程序 支付宝小程序 百度小程序 字节小程序 QQ小程序
HBuilderX 3.5.1 app-vue ×
钉钉小程序 快手小程序 飞书小程序 京东小程序
× × ×
H5-Safari Android Browser 微信浏览器(Android) QQ浏览器(Android) Chrome IE Edge Firefox PC-Safari
× ×

yui-tabs 关于标签页组件

Tips
  • 组件于2022.09.25 13:00有改动,若有bug,请更新最新代码尝试是否修复。
  • 请保证HBuilderX正式版为 v3.4.18、Alpha版为 v3.5.1,否则用于渲染tab内容的动态插槽无效。
  • 该插件使用的预编译,需要自行安装less插件。
  • 如果发现组件有bug或者不完善可以留言交流。
  • 如需详细的了解本组件,请下载示例项目ZIP运行查看效果(标签页组件在uni_modules/yui-tabs下)。
  • 旧版本放在uni_modules/yui-tabs/version中。
  • 关于标签栏滚动吸顶提供了两种实现方式,具体可查看示例项目中的演示。
  • 由于vue3不支持小程序端的标签内容展示,为此重构了一个新的标签页组件,以后的优化同样会侧重于此;本组件仍旧会修复相关bug。 新标签页组件地址
  • 右侧的微信小程序码可以查看具体的效果。
支持的平台:
  • H5、app-vue、微信、支付宝、钉钉、百度、字节、QQ小程序可用,其他的小程序平台可自行测试。
  • 暂不支持nvue。
  • vue3版本仅支持H5、app-vue,若想支持小程序端,请移步上面的新标签页地址。
使用示例:
<template>
 <view>
     <yui-tabs :tabs="tabs" v-model="activeIndex" @click="tabClick" @change="tabChange">
        <template #pane0>
            <view class="content-wrap">内容1</view>
        </template>
        <template #pane1>
            <view class="content-wrap">内容2</view>
        </template>
        <template #pane2>
            <view class="content-wrap">内容3</view>
        </template>
        <template #pane3>
            <view class="content-wrap">内容4</view>
        </template>
        <template #pane4>
            <view class="content-wrap">内容5</view>
        </template>
     </yui-tabs>
 </view>
</template>
<script>
    export default {
        data() {
            return {
                tabs: Array.from({
                    length: 5
                }, (o, i) => `标签${i+1}`),
                activeIndex: 0,
            }
        },
        methods: {
            // 标签点击事件
            tabClick(index, item) {
                console.log("tabClick", index, item);
            },
            // 标签切换事件
            tabChange(index, item) {
                console.log("tabChange", index, item);
            }
        }
    }
</script>
滚动吸顶示例:
  • 本示例只展示使用sticky方式实现的标签栏吸顶
  • 直接开启sticky属性,并结合页面生命周期onPageScroll,调用uni.$emit('onPageScroll', e),否则无法吸顶

    <template>
    <view>
     <yui-tabs :tabs="tabs" v-model="activeIndex" sticky :offsetTop="offsetTop">
        <template #pane0>
            <view class="content-wrap">内容1</view>
        </template>
        <template #pane1>
            <view class="content-wrap">内容2</view>
        </template>
        <template #pane2>
            <view class="content-wrap">内容3</view>
        </template>
        <template #pane3>
            <view class="content-wrap">内容4</view>
        </template>
        <template #pane4>
            <view class="content-wrap">内容5</view>
        </template>
     </yui-tabs>
    </view>
    </template>
    <script>
    export default {
        data() {
            return {
                tabs: Array.from({
                    length: 5
                }, (o, i) => `标签${i+1}`),
                activeIndex: 0,
                offsetTop: 0, //粘性定位布局下与顶部的最小距离
            }
        },
        mounted() {
            uni.getSystemInfo({
                success: (e) => {
                    let offsetTop = 0
                    // #ifdef H5
                    offsetTop = 43
                    // #endif
    
                    this.offsetTop = offsetTop;
                }
            })
        },
        // 页面滚动触发事件
        onPageScroll(e) {
            //页面滚动事件
            uni.$emit('onPageScroll', e)
        },
    }
    </script>
    <style>
    .content-wrap{
    height:200vh;
    }
    </style>
Tabs Props
参数类型描述默认值
v-model string 绑定当前选中标签的标识符(即tabs中选中项的下标) 0
type(v1.0.6) string 样式风格类型,可选值为 text、card、button、line-button line
tabs [stirng,object] 标签页数据,支持字符串类型与对象类型的数组结构(对象类型需符合{label:'标签1',slot:'slotName'}这样的格式,slot为自定义的标签内容插槽名,否则插槽名默认为"pane"+tab下标的命名),见下文"tabs数组参数" -
color string 标签主题色 #0022AB
background string 标签栏背景色 #fff
title-active-color string 标题选中态颜色 -
title-inactive-color string 标题默认态颜色 -
wrapStyle object 标签栏样式 -
duration number、string 动画时间,单位秒(用于标签栏底部线条切换及标签内容转场动画时长) 0.3
line-width number、string 底部条宽度,默认单位 px,仅在 type="line" 时有效 20px
line-height number、string 底部条高度,默认单位 px,仅在 type="line" 时有效 3px
ellipsis boolean 是否省略过长的标题文字 true
scroll-to-center boolean 标签栏滚动时当前标签居中 true
scroll-threshold number、string 标签栏的滚动阈值(仅在ellipsis="false"且type不为"card"下时有效),标签数量超过阈值且总宽度超过标签栏宽度时开始横向滚动(切换时会自动将当前标签居中) 5
is-lazy-render boolean 是否开启延迟渲染(首次切换到标签时才触发内容渲染) true
animated boolean 是否开启切换标签内容时的转场动画 false
tab-click-scroll-top (v.1.0.8) boolean 在点击标签标题时,页面是否会滚动回到顶部 false
no-render-conent(v.1.0.9) boolean 对于只想使用标题栏功能而不关注标签内容,可使用该属性关闭标签内容的渲染 false
before-change (v.1.0.9) (index) => boolean | Promise 切换标签前的回调函数,返回 false 可阻止切换,支持返回 Promise -
scrollspy(v.1.0.9) boolean 是否开启滚动导航;该模式下,内容将会平铺展示 false
swipeable boolean 是否开启手势滑动切换 false
swiper(v1.0.7) boolean 标签内容的滑动切换是否使用swiper组件实现(为false时是默认实现,swiper以下的所有prop都属于默认实现);注意:该方式是为了解决默认的左右滑动切换不友好的情况,因此无法兼容uni自身的上拉加载与下拉刷新事件,请到插件市场寻找类似的组件 false
--
以下prop,仅在swiper="false"时有效
swipe-threshold number、string 滑动切换的滑动距离阈值,手指滑动页面触发切换的阈值,单位为px;表示开启手势滑动时,横向滑动整个可视区域的多少px时才切换标签内容 50
swipe-animated(v1.0.6) boolean 是否开启标签内容滑动时的拖动动画(该属性依赖于animated、swipeable、is-lazy-render的开启;该属性开启时考虑给包裹内容的容器增加一个min-height,因为开启该属性后,其他未显示出来的标签内容会沿用当前显示的高度,拖动切换后由于高度不一致会有回弹) 0
--
以下prop,是用于实现滚动吸顶提供的属性,分为fixed与sticky方式,这两种方式都是在特定的场景下实现,请查看示例项目,里面有具体的说明
---- fixed方式:使用两个标签页组件模拟滚动吸顶 ----
fixed boolean 标签页是否滚动吸顶(请查看示例项目中的具体用法;示例->滚动吸顶(fixed方式);与sticky的效果相同,但是不推荐使用) false
visible boolean 标签栏可见性,结合fixed使用,用于模拟滚动吸顶 true
---- sticky方式:结合页面生命周期onPageScroll实现 ----
sticky(v1.0.6) boolean 是否使用粘性定位布局(请查看示例项目中的具体用法;示例->滚动吸顶(sticky方式)) false
sticky-threshold(v1.0.6) number 粘性定位布局的判断阈值 0
------ (fixed与sticky方式共有) -----
offset-top number 滚动吸顶(粘性定位布局)下与顶部的最小距离,默认 px 0
z-index number 滚动吸顶(粘性定位布局)下,标签栏的z-index值 99
tabs数组参数

注意:

  • 请勿在组件初始化之后删除或添加tabs数组,否则会导致组件内部重新初始化一遍
  • 在组件初始化之后,仅支持更改label,badge,dot的值
参数 类型 描述 默认值
label string 标题 -
slot string 标签内容插槽名 'pane'+下标
titleSlot number/string 标题插槽名 'title'+下标
dot boolean 是否在标题右上角显示小红点(优先级高于badge) false
badge number/string 图标右上角徽标的内容 -
Tabs Events
事件名 说明 回调参数
click 点击标签时触发 index:下标;item:当前点击的tab项;isTabClick:是否为标签标题点击时触发的该事件
change 当前激活的标签改变时触发 index:下标;item:当前改变的tab项;isTabClick:是否为标签标题点击时触发的该事件
rendered 标签内容首次渲染时触发(仅在开启延迟渲染后触发) index:下标;item:当前改变的tab项
scroll 滚动时触发,仅在 sticky 模式下生效 { scrollTop: 距离顶部位置, isFixed: 是否吸顶 }
Tabs Slots
名称 说明
extra 标签栏右侧额外内容
pane+下标 标签内容插槽,插槽名默认为"pane"+tab下标,如果tabs中通过slot设置了插槽名,则使用slot的值
title+下标 标签标题插槽,插槽名默认为"title"+tab下标,如果tabs中通过titleSlot设置了插槽名,则使用titleSlot的值
Tabs 方法

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

方法名 说明 参数 返回值
resize 外层元素大小或组件显示状态变化时,可以调用此方法来触发重绘 - -
注意事项及常见问题
  1. 关于swiper属性对于标签内容左右滑动的实现方式,何时使用swpier组件实现,何时使用默认方式实现?

    • 默认实现下,如果启用swipe-animated拖动动画,在左右滑动时极易触发上下滑动,建议如下:

    • 想保留页面级的上拉加载与下拉刷新事件

    • 或者只想要标题栏部分的切换功能,不使用插槽渲染出标签内容,自己去实现具体的展示内容

    • swpier组件实现下,由于该组件是absolute定位,需要给定标签内容具体的高度,无法触发页面级的上拉加载与下拉刷新事件,建议如下:

    • 想有良好的左右滑动效果,每个标签内容卡片中互不影响,各自使用scroll-view组件承载内容

    • 由于无法触发页面级的上拉加载与下拉刷新事件,因此需要去插件市场找类似的插件

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

MIT协议

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问