微信小程序自定义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 相关文章推荐
jquery弹出关闭遮罩层实例
Aug 06 Javascript
JS中判断JSON数据是否存在某字段的方法
Mar 07 Javascript
AngularJS入门教程之Hello World!
Dec 06 Javascript
jQuery实现ajax调用WCF服务的方法(附带demo下载)
Dec 04 Javascript
AngularJS equal比较对象实例详解
Sep 14 Javascript
javascript滚轮控制模拟滚动条
Oct 19 Javascript
JS基于递归算法实现1,2,3,4,5,6,7,8,9倒序放入数组中的方法
Jan 03 Javascript
详解Angular 4.x 动态创建组件
Apr 25 Javascript
JavaScript数据结构与算法之二叉树遍历算法详解【先序、中序、后序】
Feb 21 Javascript
原生JS生成指定位数的验证码
Oct 28 Javascript
如何在JavaScript中等分数组的实现
Dec 13 Javascript
JavaScript架构localStorage特殊场景下二次封装操作
Jun 21 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入门学习笔记之一
2010/10/12 PHP
php简单获取文件扩展名的方法
2015/03/24 PHP
PHP简单实现正则匹配省市区的方法
2018/04/13 PHP
PHP7.1实现的AES与RSA加密操作示例
2018/06/15 PHP
javascript实现动态增加删除表格行(兼容IE/FF)
2007/04/02 Javascript
Jquery实现无刷新DropDownList联动实现代码
2010/03/08 Javascript
仅IE9/10同时支持script元素的onload和onreadystatechange事件分析
2011/04/27 Javascript
js Array对象的扩展函数代码
2013/04/24 Javascript
JS显示表格内指定行html代码的方法
2015/03/31 Javascript
JavaScript动态修改背景颜色的方法
2015/04/16 Javascript
jquery获取url参数及url加参数的方法
2015/10/26 Javascript
Jquery 全选反选实例代码
2015/11/19 Javascript
Javascript缓存API
2016/06/14 Javascript
jquery层级选择器的实现(匹配后代元素div)
2016/09/05 Javascript
jqGrid翻页时数据选中丢失问题的解决办法
2017/02/13 Javascript
nodejs接入阿里大鱼短信验证码的方法
2017/07/10 NodeJs
react学习笔记之state以及setState的使用
2017/12/07 Javascript
npm全局模块卸载及默认安装目录修改方法
2018/05/15 Javascript
Vue props中Object和Array设置默认值操作
2020/07/30 Javascript
解决Ant Design Modal内嵌Form表单initialValue值不动态更新问题
2020/10/29 Javascript
Python 类的继承实例详解
2017/03/25 Python
Django 限制用户访问频率的中间件的实现
2018/08/23 Python
python自动发邮件总结及实例说明【推荐】
2019/05/31 Python
Python异常处理例题整理
2019/07/07 Python
Python Matplotlib简易教程(小白教程)
2020/07/28 Python
Python实现冒泡排序算法的完整实例
2020/11/04 Python
HTML5是什么 HTML5是什么意思 HTML5简介
2012/10/26 HTML / CSS
谷歌浏览器小字体处理方案即12px以下字体
2013/12/17 HTML / CSS
英国领先的露营和露营车品牌之一:OLPRO
2019/08/06 全球购物
Michael Kors澳大利亚官网:世界知名的奢侈饰品和成衣设计师
2020/02/13 全球购物
我爱我家教学反思
2014/05/01 职场文书
教育项目合作协议书格式
2014/10/17 职场文书
2014年评职称工作总结
2014/11/20 职场文书
大学生志愿者心得体会
2016/01/15 职场文书
PyMongo 查询数据的实现
2021/06/28 Python
Mysql中有关Datetime和Timestamp的使用总结
2021/12/06 MySQL