微信小程序自定义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 相关文章推荐
在IE中调用javascript打开Excel的代码(downmoon原作)
Apr 02 Javascript
JQuery事件e参数的方法preventDefault()取消默认行为
Sep 26 Javascript
js中实现多态采用和继承类似的方法
Aug 22 Javascript
在HTML代码中使用JavaScript代码的例子
Oct 16 Javascript
用JavaScript判断CSS浏览器类型前缀的两种方法
Oct 08 Javascript
Bootstrap缩略图的创建方法
Mar 22 Javascript
vue项目中用cdn优化的方法
Jan 03 Javascript
Express之托管静态文件的方法
Jun 01 Javascript
微信小程序 网络通信实现详解
Jul 23 Javascript
解决vue-cli webpack打包开启Gzip 报错问题
Jul 24 Javascript
Vue登录拦截 登录后继续跳转指定页面的操作
Aug 04 Javascript
详细分析JavaScript中的深浅拷贝
Sep 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 动态多文件上传
2009/01/18 PHP
php 文件缓存函数
2011/10/08 PHP
详解WordPress中添加和执行动作的函数使用方法
2015/12/29 PHP
jQuery html()等方法介绍
2009/11/18 Javascript
在Ubuntu上安装最新版本的Node.js
2014/07/14 Javascript
基于JavaScript实现Json数据根据某个字段进行排序
2015/11/24 Javascript
JavaScript字符串对象
2017/01/14 Javascript
JS仿JQuery选择器功能
2017/03/08 Javascript
vue实现登录后页面跳转到之前页面
2018/01/07 Javascript
为什么要使用Vuex的介绍
2019/01/19 Javascript
jQuery内容选择器与表单选择器实例分析
2019/06/28 jQuery
JS实现音乐导航特效
2020/01/06 Javascript
微信公众号中的JSSDK接入及invalid signature等常见错误问题分析(全面解析)
2020/04/11 Javascript
JS如何调用WebAssembly编译出来的.wasm文件
2020/11/05 Javascript
NodeJS配置CORS实现过程详解
2020/12/02 NodeJs
Python编码类型转换方法详解
2016/07/01 Python
在Python中通过threading模块定义和调用线程的方法
2016/07/12 Python
Python标准库之itertools库的使用方法
2017/09/07 Python
基于Django的ModelForm组件(详解)
2017/12/07 Python
Python3.5.3下配置opencv3.2.0的操作方法
2018/04/02 Python
Django 实现购物车功能的示例代码
2018/10/08 Python
强悍的Python读取大文件的解决方案
2019/02/16 Python
Python3中列表list合并的四种方法
2019/04/19 Python
python可视化text()函数使用详解
2020/02/11 Python
美国男士内衣品牌:Tommy John
2017/12/22 全球购物
汇集了世界上最好的天然和有机美容产品:LoveLula
2018/02/05 全球购物
Stio官网:男女、儿童户外服装
2019/12/13 全球购物
销售顾问的岗位职责
2013/11/13 职场文书
化学实验员岗位职责
2013/12/28 职场文书
家具促销活动方案
2014/02/16 职场文书
《莫高窟》教学反思
2014/02/25 职场文书
售房协议书范本2014
2014/10/23 职场文书
民事申诉状范本
2015/05/20 职场文书
论语读书笔记
2015/06/26 职场文书
导游词之麻姑仙境
2019/11/18 职场文书
nginx实现多geoserver服务的负载均衡
2022/05/15 Servers