微信小程序自定义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支持function.bind()方法实现代码
Dec 27 Javascript
jQuery之排序组件的深入解析
Jun 19 Javascript
判断及设置浏览器全屏模式
Apr 20 Javascript
JS 新增Cookie 取cookie值 删除cookie 举例详解
Oct 10 Javascript
JS获取图片lowsrc属性的方法
Apr 01 Javascript
简介JavaScript中的getSeconds()方法的使用
Jun 10 Javascript
Vue.js常用指令汇总(v-if、v-for等)
Nov 03 Javascript
Bootstrap 设置datetimepicker在屏幕上面弹出设置方法
Mar 21 Javascript
Node.js 中使用 async 函数的方法
Nov 20 Javascript
JavaScript中Object基础内部方法图
Feb 05 Javascript
js仿360开机效果
Dec 26 Javascript
详解React 条件渲染
Jul 08 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
一台收音机,让一家人都笑逐颜开!
2020/08/21 无线电
PHP 一个页面执行时间类代码
2010/03/05 PHP
php页面跳转代码 输入网址跳转到你定义的页面
2013/03/28 PHP
PHP字符串的连接的简单实例
2013/12/30 PHP
PHP封装的HttpClient类用法实例
2015/06/17 PHP
JqGrid web打印实现代码
2011/05/31 Javascript
jquery1.9 下检测浏览器类型和版本的方法
2013/12/26 Javascript
Jquery给基本控件的取值、赋值示例
2014/05/23 Javascript
jQuery on()方法示例及jquery on()方法的优点
2015/08/27 Javascript
JavaScript实现的多种鼠标拖放效果
2015/11/03 Javascript
Bootstrap~多级导航(级联导航)的实现效果【附代码】
2016/03/08 Javascript
JS+CSS实现闪烁字体效果代码
2016/04/05 Javascript
浅谈JavaScript 函数参数传递到底是值传递还是引用传递
2016/08/23 Javascript
Node.js的基本知识简单汇总
2016/09/19 Javascript
详解Javascript中的原型OOP
2016/10/12 Javascript
javascript中json基础知识详解
2017/01/19 Javascript
jQuery树控件zTree使用方法详解(一)
2017/02/28 Javascript
解决vue多个路由共用一个页面的问题
2018/03/12 Javascript
JavaScript迭代器的含义及用法
2019/06/21 Javascript
Vue中axios的封装(报错、鉴权、跳转、拦截、提示)
2019/08/20 Javascript
vue实现div单选多选功能
2020/07/16 Javascript
Vue3 响应式侦听与计算的实现
2020/11/11 Javascript
Vue看了就会的8个小技巧
2021/01/21 Vue.js
[48:12]Secret vs Optic Supermajor 胜者组 BO3 第三场 6.4
2018/06/05 DOTA
Python matplotlib画图与中文设置操作实例分析
2019/04/23 Python
Python实现对adb命令封装
2020/03/06 Python
在Sublime Editor中配置Python环境的详细教程
2020/05/03 Python
英国领先的运动营养品牌:Protein Dynamix
2018/01/02 全球购物
Roxy俄罗斯官方网站:冲浪和滑雪板的一切
2020/06/20 全球购物
元旦获奖感言
2014/03/08 职场文书
家长对学生的评语
2014/04/18 职场文书
不服从公司安排检讨书
2014/09/24 职场文书
健康状况证明模板
2014/10/23 职场文书
北京英文导游词
2015/02/12 职场文书
茶花女读书笔记
2015/06/29 职场文书
幼儿教师继续教育培训心得体会
2016/01/19 职场文书