微信小程序自定义tabBar的踩坑实践记录


Posted in Javascript onNovember 06, 2020

微信官方文档对自定义 tabBar 的阐述较为潦草,在开发自定义 tabBar 过程中我踩了很多坑,因此在此处做个总结。

我使用 Vant Weapp 作为 UI 组件库,下面以此组件库为例。

定义 tabBar

创建自定义 tabBar 文件

创建一个与 /pages 的同级目录,命名为  /custom-tab-bar,注意目录层级与目录命名问题,不可用其他名称命名。
在 /custom-tab-bar 下创建四个文件:

index.js
index.json
index.wxml
index.wxss

index.js

在 index.js 中我们定义相关数据:

  • active:当前被点击 tab 的索引
  • list:tab 列表

以及一个切换 tab 时触发的方法:

function onChange(event):标签切换时触发,修改 active 值,点亮被点击的 tab 并进行页面跳转

Component({
 data: {
 // 选中的 tab 
 active: null,
 // 菜单列表
 list: [
  {
  pagePath: '/pages/subscriptions/subscriptions',
  text: '订阅',
  name: 'subscriptions',
  icon: 'bullhorn-o'
  },
  {
  pagePath: '/pages/profile/profile',
  text: '我的',
  name: 'profile',
  icon: 'user-o'
  }
 ]
 },
 methods: {
 // 标签切换
 onChange: function (event) {
  this.setData({ active: event.detail })
  wx.switchTab({
  url: this.data.list[event.detail].pagePath,
  })
 }
 }
})

index.json

在 index.json 中,将 component 参数值设为 true,代表这是一个自定义组件:

{
 "component": true
}

因为我使用了Vant Weapp 的 tabBar 标签栏,所以还需引入额外组件:

{
 "component": true,
 "usingComponents": {
 "van-tabbar": "@vant/weapp/tabbar/index",
 "van-tabbar-item": "@vant/weapp/tabbar-item/index",
 "van-icon": "@vant/weapp/icon/index"
 }
}

index.wxml

在 index.wxml 中定义组件形态,我在此处使用Vant Weapp 的 tabBar 标签栏,详见代码,不再赘述。

<van-tabbar active="{{ active }}" bind:change="onChange">
 <van-tabbar-item 
 wx:for="{{list}}" 
 wx:key="index"
 icon="{{item.icon}}" 
 data-path="{{item.pagePath}}">
 {{item.text}}
 </van-tabbar-item>
</van-tabbar>

配置 app.json

在 app.json 中配置如下参数:

  • usingComponents:仅声明即可
  • tabBar:tabBar 组件的具体配置
    • custom:设为 true,表示使用自定义组件
    • list:tab 页列表,在列表中的页面将被设置为 tab 页,自动加载 tabBar
{
 "usingComponents":{

 },
 "tabBar":{
  "custom":true,
  "color":"#000000",
  "selectedColor":"#000000",
  "backgroundColor":"#000000",
  "list":[
   {
    "pagePath":"pages/subscriptions/subscriptions",
    "text":"订阅列表",
    "iconPath":"",
    "selectedIconPath":""
   },
   {
    "pagePath":"pages/profile/profile",
    "text":"关于我",
    "iconPath":"",
    "selectedIconPath":""
   }
  ]
 }
}

实现 tabBar 选中态

根据微信官方文档描述,每个 tab 页面 tabBar 的实例是不同的:

每个 tab 页下的自定义 tabBar 组件实例是不同的,可通过自定义组件下的 getTabBar 接口,获取当前页面的自定义 tabBar 组件实例。

显而易见,每当切换 tab 页时,我们都需要更新 tabBar 的选中态。关于选中态的实现,官方文档描述如下:

注意:如需实现 tab 选中态,要在当前页面下,通过 getTabBar 接口获取组件实例,并调用 setData 更新选中态。

我们可以在使用到 tabBar 的页面中这样实现:

Page({
 onShow: function () {
 if (typeof this.getTabBar === 'function' && this.getTabBar()) {
  this.getTabBar().setData({
  // 当前页面的 tabBar 索引
  active: 1
  })
 }
 }
})

至此,一个自定义 tabBar 的实现已全部完成。

踩坑

getTabBar() 方法缺失

在实现 tabBar 选中态时遇到 getTabBar() 方法缺失的问题。在小程序开发工具中跳转到 getTabBar() 方法的定义,我们可以看到:

/**
 * 返回当前页面的 custom-tab-bar 的组件实例
 *
 * 最低基础库版本:[`2.6.2`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
 **/
getTabBar(): TrivialInstance

该方法的最低基础版本库为 2.6.2,我们修改 project.config.json 文件中的 libVersion 字段,升级到指定版本库即可。
升级版本库后 tabBar 组件报错

报错内容如下:

Component is not found in path "custom-tab-bar/index"

该原因是由于 tabBar 组件目录放置错误导致的,需要注意以下几点:

  1. 目录需与 /pages 同级
  2. 目录名称是 custom-tab-bar
  3. 目录下所包含的文件名为 index.后缀
  4. 在 app.json 配置中,tabBar 下的 custom 字段需设置为 true

getTabBar() 始终返回 null

依旧是目录放置与文件命名问题,处理方法同上。

另外,不需要在 app.json 的 usingComponents 引入 tabBar 组件,如果你放置目录与命名正确,小程序会自动引入。

参考文档

  • 小程序官方文档:自定义 tabBar
  • 官方自定义 tabbar 的显示和隐藏
  • 使用自定义 tabbar,在 tab 页中使用 this.getTabBar() 一直返回 null,什么原因?
  • getTabBar 无法调用 接口相关说明在哪里?

总结

到此这篇关于微信小程序自定义tabBar踩坑实践记录的文章就介绍到这了,更多相关微信小程序自定义tabBar踩坑内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Javascript 相关文章推荐
window.location.hash 属性使用说明
Mar 20 Javascript
js常用代码段收集
Oct 28 Javascript
JSONP跨域的原理解析及其实现介绍
Mar 22 Javascript
深入探密Javascript数组方法
Jan 08 Javascript
JavaScript动态修改背景颜色的方法
Apr 16 Javascript
javascript实现tab切换特效
Nov 12 Javascript
JavaScript中如何使用cookie实现记住密码功能及cookie相关函数介绍
Nov 10 Javascript
详解vue中引入stylus及报错解决方法
Sep 22 Javascript
详解Web使用webpack构建前端项目
Sep 23 Javascript
react-native滑动吸顶效果的实现过程
Jun 03 Javascript
判断JavaScript中的两个变量是否相等的操作符
Dec 21 Javascript
js加减乘除精确运算方法实例代码
Jan 17 Javascript
浅谈nuxtjs校验登录中间件和混入(mixin)
Nov 06 #Javascript
nuxt.js 在middleware(中间件)中实现路由鉴权操作
Nov 06 #Javascript
vue中的计算属性和侦听属性
Nov 06 #Javascript
nuxt.js添加环境变量,区分项目打包环境操作
Nov 06 #Javascript
使用Vue实现一个树组件的示例
Nov 06 #Javascript
Nuxt.js 静态资源和打包的操作
Nov 06 #Javascript
微信小程序基于ColorUI构建皮皮虾短视频去水印组件
Nov 04 #Javascript
You might like
PHP中使用gettext来支持多语言的方法
2011/05/02 PHP
php检测文件编码的方法示例
2014/04/25 PHP
PHP中实现Bloom Filter算法
2015/03/30 PHP
PHP精确计算功能示例
2016/11/29 PHP
jquery 查找select ,并触发事件的实现代码
2011/03/30 Javascript
JS对select控件option选项的增删改查示例代码
2013/10/21 Javascript
文本框(input)获取焦点(onfocus)时样式改变的示例代码
2014/01/10 Javascript
JS+CSS实现淡入式焦点图片幻灯切换效果的方法
2015/02/26 Javascript
详解Angularjs中的依赖注入
2016/03/11 Javascript
Angularjs单选改为多选的开发过程及问题解析
2017/02/17 Javascript
Node.js获取前端ajax提交的request信息
2017/02/20 Javascript
jQuery的$.extend 浅拷贝与深拷贝
2017/03/08 Javascript
基于JS脚本语言的基础语法详解
2017/07/22 Javascript
老生常谈js中的MVC
2017/07/25 Javascript
webpack构建react多页面应用详解
2017/09/15 Javascript
vue.js整合mint-ui里的轮播图实例代码
2017/12/27 Javascript
详解Javascript中new()到底做了些什么?
2018/03/29 Javascript
vue keep-alive请求数据的方法示例
2018/05/16 Javascript
jQuery获取随机颜色的实例代码
2018/05/21 jQuery
Vue模拟数据,实现路由进入商品详情页面的示例
2018/08/31 Javascript
浅谈webpack4.x 入门(一篇足矣)
2018/09/05 Javascript
Vue中使用vux配置代码详解
2018/09/16 Javascript
浅谈React中组件逻辑复用的那些事儿
2020/05/21 Javascript
一篇文章看懂JavaScript中的回调
2021/01/05 Javascript
python二分法实现实例
2013/11/21 Python
Python中的pass语句使用方法讲解
2015/05/14 Python
对IPython交互模式下的退出方法详解
2019/02/16 Python
pycharm第三方库安装失败的问题及解决经验分享
2020/05/09 Python
keras .h5转移动端的.tflite文件实现方式
2020/05/25 Python
OpenCV实现机器人对物体进行移动跟随的方法实例
2020/11/09 Python
PHP如何调用MYSQL存储过程
2014/05/30 面试题
腾讯公司的一个sql题
2013/01/22 面试题
2015年实习班主任工作总结
2015/04/23 职场文书
分享提高 Python 代码的可读性的技巧
2022/03/03 Python
面试分析分布式架构Redis热点key大Value解决方案
2022/03/13 Redis
Python学习之异常中的finally使用详解
2022/03/16 Python