# y-tabs 标签页组件 注意: + 2.0.1+为非兼容性升级,重命名了诸多样式以及提供的属性名,也移除了部分属性及事件,如无必要,请勿升级,具体调整内容请查看更新记录。 + [Tips](#tips) + [支持的平台](#supportPlatform) + [使用方式](#usageMode) + [滚动吸顶示例](#scrollExamples) + [与swiper联动示例](#LinkWithSwiperExamples) + [Tabs Props](#tabsProps) + [Tab Props](#tabProps) + [Tabs Events](#tabsEvents) + [Tabs Methods](#tabsMethod) + [Tabs Slots](#tabsSlots) + [Tab Slots](#tabSlots) + [注意事项及常见问题](#beCareful)
## Tips + 如果有问题,可尝试下载最新代码(示例项目中的`uni_modules/y-tabs`是最新的)。 + 请保证HBuilderX正式版为 `v3.4.18`、Alpha版为 `v3.5.2`。 + 使用该插件需安装`scss`插件。 + 点击右上角的“使用HubilderX导入示例项目”按钮下载示例项目运行并查看效果,项目中内置不少案例。 + 也可扫描右侧图片中的微信小程序码查看(由于微信小程序审核较严,无法发布新版本,因此案例较老,最好运行示例项目查看)。 + 可以加QQ群交流反馈:`566764891`;也可以邮箱或QQ留言:`18508420370@163.com`、`1431948195`。 ## 支持的平台 + H5、app-vue、微信、支付宝、钉钉、百度、字节、QQ、飞书、快手、京东小程序可用。 + 暂不支持nvue及快应用。 ## 使用方式 ### 1、通过HbuilerX创建项目 + 该组件符合`uni_modules`规范,使用`HbuilderX`导入插件到项目根目录下的`uni_modules`文件夹中。 + `template`中直接使用,无需单独引入注册组件。 + 该组件依赖于`uni-icons`,请单独导入。 ### 2、通过vue cli创建项目 + 需保证src下面有`uni_modules`文件夹,将y-tabs拷贝到里面 + 在`pages.json`中通过`easycom`的方式引入组件(tabs组件中使用了uni-icons,因此需要引入uni-ui) ``` json { "easycom": { "autoscan": true, "custom": { "^uni-(.*)": "@dcloudio/uni-ui/lib/uni-$1/uni-$1.vue", "^y-(.*)": "@/uni_modules/y-$1/components/y-$1.vue" } }, } ``` #### 普通案例 + 注意:在QQ/百度/字节跳动/飞书/快手小程序中,自定义组件在渲染时会比App/H5端多一级节点,导致标签内容样式失效,需在组件上添加"`.y-tab-virtual`"的样式 ```参数 | 类型 | 描述 | 默认值 | 说明 |
---|---|---|---|---|
v-model | number、string | 绑定当前选中标签的标识符 | 0 | 即tab选中项的下标或者tab的name属性值 |
type | string | 样式风格类型 | line | 可选值为 text、card、button、line-button |
color | string | 标签主题色 | #0022AB | |
background | string | 标签栏背景色 | #fff | |
title-active-color | string | 标题选中态颜色 | - | |
title-inactive-color | string | 标题默认态颜色 | - | |
wrap-style | object | 标签栏样式 案例 :透明导航栏下的滚动吸顶 | - | |
direction | string | 标签栏的展示方位 | horizontal | 可选值:vertical |
duration | number、string | 动画时间,单位秒 | 0.3 | 仅支持type为line、button、line-button的滑块移动的动画时间,标签内容切换时的转场动画时间、页面级滚动导航的内容定位动画时间。 |
shrink | boolean | 通过 shrink 属性可以开启收缩布局,开启后,所有的标签会向左侧收缩对齐 | false | |
bar-width V2.0.1 | number、string | 滑块宽度,支持rpx、vh、vw等单位及calc()函数,也可传入'auto'值,默认px。 | type为line,标签栏水平、垂直时宽度分别为20px、3px,其余为选中标签宽度;为auto时,代表滑块宽度自适应于选中标签宽度(仅在type='line'且bar-animate-mode='linear'、direction='horizontal'下生效) | 仅支持type为line、button、line-button。 |
bar-height V2.0.1 | number、string | 滑块高度,支持度同bar-width | type为line,标签栏水平、垂直时宽度分别为3px、20px,其余为选中标签高度;为auto时,代表滑块高度自适应于选中标签高度(仅在type='line'、bar-animate-mode='linear'、direction='vertical'下生效) | 同bar-width |
bar-style V2.0.1 | object | 滑块样式 | - | 同bar-width |
bar-animate-mode V2.0.1 | string | 滑动切换tab内容时滑块的动画模式,默认为linear。可选值:worm(毛毛虫蠕动)、worm-ease(毛毛虫缓动效果)、none(不设置)。 | linear | 仅在 type='line'、direction='horizontal' 时有效。 可结合swiper组件使用,效果更好 案例 :新闻列表、与swiper组件联动 |
is-dynamic V2.0.1 | boolean | 标签切换后宽高是否有变化 | true | 当选中标签会放大文字、减少内间距时,开启该属性可避免滑块错位。(如果选中的标签文字使用‘font-size:20px;transition: all .2s’进行过渡变化,开启该属性仍旧会错位) |
ellipsis | boolean | 是否省略过长的标题文字 | true | 标签栏水平展示时,如果标签数量未超过滚动阈值则生效,垂直则不限制。 |
scroll-threshold | number、string | 滚动阈值,标签数量超过阈值且总宽度超过标签栏宽度时开始横向滚动 | 5 | |
scroll-to-center | boolean | 标签栏滚动时当前标签居中 | true | |
is-lazy-render | boolean | 是否开启延迟渲染(首次切换到标签时才触发内容渲染) | false | |
animated | boolean | 是否开启动画 | true | 用于开启标签栏滚动的过渡动画、切换标签内容时的转场动画、滚动导航下的内容定位动画 |
active-last V2.0.1 | boolean | 在滚动导航模式下,滚动到最后一个标签内容但其顶部未超过可视区域时,是否激活对应的标签项 | false | |
before-change | (name) => boolean | Promise | 切换标签前的回调函数,返回 false 可阻止切换,支持返回 Promise | - | name为v-model绑定的值 |
内容手势滑动切换相关属性 : | ||||
swipeable | boolean | 是否开启手势滑动切换 案例 :滑动切换 | 新闻列表 | 滚动吸顶+左右滑动 | false | |
swipe-animated | boolean | 是否开启标签内容滑动时的拖动动画 | true | swipeable为true、且is-lazy-render为false时有效 |
swipe-threshold | number、string | 滑动切换的滑动距离阈值,单位为px;表示开启手势滑动时,横向滑动多少px切换标签内容 | 120 | 快速滑动时不受限制 |
滚动吸顶相关属性 : | ||||
sticky | boolean | 是否使用粘性布局进行滚动吸顶 案例 :滚动吸顶 | false | |
offset-top | number、string | 粘性布局下标签栏与顶部的最小距离,单位为 px | 0 | 注意单位问题,如果是rpx,需要uni.upx2px转为px |
z-index | number、string | 粘性布局下,标签栏的z-index值 | 99 | |
sticky-threshold | number、string | 粘性布局吸顶的判断阈值 | 0 | 表示在页面滚动时,标签栏距屏幕顶部多少px时会触发吸顶函数进行吸顶判断 案例 :透明导航栏下的滚动吸顶 |
transparent | boolean | 页面滚动过程中,标题栏背景色是否透明渐变 案例 :透明渐变标题栏 | false | background属性值必须为rgba格式 |
transparent-offset | number、string | 标题栏背景色透明渐变的滚动距离 | 150 | 请保证标签内容的高度大于该值 |
滚动导航及侧边栏导航相关属性 : | ||||
scrollspy | boolean | 是否开启滚动导航;该模式下,内容将会平铺展示 案例 :滚动导航(页面级滚动) | false | 如果标签栏垂直展示,且内容平铺展示,就为侧边栏模式案例 :侧边栏导航(页面级滚动)-仿奶茶点单 |
page-scroll | boolean | 滚动导航模式下,内容区域是否跟随页面滚动 | true | 为false时,内容区域是放在scroll-view中实现的局部滚动,需自行设置标签页容器高度 案例 :侧边栏导航(区域滚动)-仿奶茶点单 |
参数 | 类型 | 描述 | 默认值 |
---|---|---|---|
name | number、string | 标签名称,作为匹配的标识符 | 标签的索引值 |
title | string | 标题 | - |
disabled | boolean | 是否禁用标签 | false |
dot | boolean | 是否在标题右上角显示小红点(优先级高于badge) | false |
badge | number、string | 图标右上角徽标的内容 | - |
badge-max-count V2.0.1 | number、string | 徽标数最大数字限制,超过这个数字将变成badgeMaxCount+,如果传空字符串则不设置 | 99 |
title-style | object | 自定义标题样式 | - |
title-class | string | 自定义标题类名 | - |
icon-type | string | 图标图案,为uniapp扩展组件(uni-ui)下的uni-icons的type值,customPrefix用法等同 | - |
icon-size | number、string | 图标大小 | 16 |
custom-prefix | string | 自定义图标 | - |
image-src | string | 图片路径 | - |
image-mode | string | 图片裁剪、缩放的模式,为uniapp内置组件->媒体组件—>image下的mode属性的可选值 | - |
position | string | 在有图标或图片的情况下,标题围绕它们所在的位置,可选值:left、top、bottom | right |
事件名 | 说明 | 回调参数 |
---|---|---|
click | 点击标签时触发 | name:标识符,title:标题 |
change | 当前激活的标签改变时触发 | name:标识符,title:标题 |
disabled | 点击被禁用的标签时触发 | name:标识符,title:标题 |
rendered | 标签内容首次渲染时触发(仅在开启延迟渲染后触发) | name:标识符,title:标题 |
sticky-change V2.0.1 | 吸顶时触发,仅在 sticky 模式下生效 | { isFixed: 是否吸顶 } |
loaded V2.0.6 | 组件内部初始化完成后调用 | - |
slide-change V2.0.9 | 内容页滑动时触发(仅barAnimateMode为linear、worm、worm-ease时有效) | { dx:滑动距离; rate:当前滑动长度占滑动区域的比例;targetIndex:目标下标;} |
slide-end V2.1.4 | 内容页滑动结束时触发(仅barAnimateMode为linear、worm、worm-ease时有效) | { targetIndex: 目标下标 } |
名称 | 说明 |
---|---|
nav-left | 标题左侧内容 |
nav-right | 标题右侧内容 |
title+下标 | 标签标题,插槽名默认为"title"+tab下标(注意:vue3中仅H5、app-vue有效,小程序端无效) |
bar V2.0.1 | 滑块,可自定义滑块的内容(可以设置图片等) |
名称 | 说明 |
---|---|
default | 标签页内容 |
方法名 | 说明 | 参数 | 返回值 |
---|---|---|---|
resize | 外层元素大小、标签数量变化、滑块错位以及标签定位不准时,可以调用此方法来触发组件内部初始化进行调整 | callback: 回调函数 | - |
reset | 重置组件的一些状态,并调用了resize方法进行数据初始化 | callback: 回调函数 | - |
scrollTo | 滚动到指定的标签页,在滚动导航模式下可用 | name: 标识符 | - |
setDx | 设置滑块的水平偏移量(结合swiper组件的@transition事件,设置滑块的位置;经过测试,仅在App、H5、微信、支付宝、字节跳动、QQ小程序上有良好的效果) | dx: swiper组件的e.detail.dx | - |
unlockDx | 解除对setDx()的锁定(结合swiper组件的@animationfinish事件,在动画完成后不锁定setDx) | - | - |