uni.showTabBar(options?)
显示 tabBar
showTabBar 兼容性
| Web | 微信小程序 | Android | iOS | iOS(Vapor) | HarmonyOS | HarmonyOS(Vapor) |
| 4.0 | 4.41 | 3.91 | 4.11 | x | 4.61 | 5.11 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| options | ShowTabBarOptions | 否 | | | |
|
ShowTabBarSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
ShowTabBarFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errCode | number | 是 | | | 错误码 |
| 合法值 | 描述 | | 100 | TabBar 不存在 | | 200 | 参数错误 |
|
| errSubject | string | 是 | | | 统一错误主题(模块)名称 |
| data | any | 否 | | | 错误信息中包含的数据 |
| cause | Error | 否 | | | 源错误信息,可以包含多个错误,详见SourceError |
| errMsg | string | 是 | | | |
ShowTabBarComplete 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
返回值
| 类型 | 必备 |
| Promise<ShowTabBarSuccess> | 否 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | errMsg | string | 是 | | | |
|
参见
uni.hideTabBar(options?)
隐藏 tabBar
hideTabBar 兼容性
| Web | 微信小程序 | Android | iOS | iOS(Vapor) | HarmonyOS | HarmonyOS(Vapor) |
| 4.0 | 4.41 | 3.91 | 4.11 | x | 4.61 | 5.11 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| options | HideTabBarOptions | 否 | | | |
|
HideTabBarSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
HideTabBarFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errCode | number | 是 | | | 错误码 |
| 合法值 | 描述 | | 100 | TabBar 不存在 | | 200 | 参数错误 |
|
| errSubject | string | 是 | | | 统一错误主题(模块)名称 |
| data | any | 否 | | | 错误信息中包含的数据 |
| cause | Error | 否 | | | 源错误信息,可以包含多个错误,详见SourceError |
| errMsg | string | 是 | | | |
HideTabBarComplete 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
返回值
| 类型 | 必备 |
| Promise<HideTabBarSuccess> | 否 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | errMsg | string | 是 | | | |
|
参见
uni.showTabBarRedDot(options)
显示 tabBar 某一项的右上角的红点
showTabBarRedDot 兼容性
| Web | 微信小程序 | Android | iOS | iOS(Vapor) | HarmonyOS | HarmonyOS(Vapor) |
| 4.0 | 4.41 | 3.91 | 4.11 | x | 4.61 | 5.11 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| options | ShowTabBarRedDotOptions | 是 | | | |
|
ShowTabBarRedDotSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
ShowTabBarRedDotFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errCode | number | 是 | | | 错误码 |
| 合法值 | 描述 | | 100 | TabBar 不存在 | | 200 | 参数错误 |
|
| errSubject | string | 是 | | | 统一错误主题(模块)名称 |
| data | any | 否 | | | 错误信息中包含的数据 |
| cause | Error | 否 | | | 源错误信息,可以包含多个错误,详见SourceError |
| errMsg | string | 是 | | | |
ShowTabBarRedDotComplete 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
返回值
| 类型 | 必备 |
| Promise<ShowTabBarRedDotSuccess> | 否 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | errMsg | string | 是 | | | |
|
参见
uni.hideTabBarRedDot(options)
隐藏 tabBar 某一项的右上角的红点
hideTabBarRedDot 兼容性
| Web | 微信小程序 | Android | iOS | iOS(Vapor) | HarmonyOS | HarmonyOS(Vapor) |
| 4.0 | 4.41 | 3.91 | 4.11 | x | 4.61 | 5.11 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| options | HideTabBarRedDotOptions | 是 | | | |
|
HideTabBarRedDotSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
HideTabBarRedDotFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errCode | number | 是 | | | 错误码 |
| 合法值 | 描述 | | 100 | TabBar 不存在 | | 200 | 参数错误 |
|
| errSubject | string | 是 | | | 统一错误主题(模块)名称 |
| data | any | 否 | | | 错误信息中包含的数据 |
| cause | Error | 否 | | | 源错误信息,可以包含多个错误,详见SourceError |
| errMsg | string | 是 | | | |
HideTabBarRedDotComplete 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
返回值
| 类型 | 必备 |
| Promise<HideTabBarRedDotSuccess> | 否 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | errMsg | string | 是 | | | |
|
参见
uni.setTabBarBadge(options)
为 tabBar 某一项的右上角添加文本
setTabBarBadge 兼容性
| Web | 微信小程序 | Android | iOS | iOS(Vapor) | HarmonyOS | HarmonyOS(Vapor) |
| 4.0 | 4.41 | 3.91 | 4.11 | x | 4.61 | 5.11 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| options | SetTabBarBadgeOptions | 是 | | | |
|
SetTabBarBadgeSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
SetTabBarBadgeFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errCode | number | 是 | | | 错误码 |
| 合法值 | 描述 | | 100 | TabBar 不存在 | | 200 | 参数错误 |
|
| errSubject | string | 是 | | | 统一错误主题(模块)名称 |
| data | any | 否 | | | 错误信息中包含的数据 |
| cause | Error | 否 | | | 源错误信息,可以包含多个错误,详见SourceError |
| errMsg | string | 是 | | | |
SetTabBarBadgeComplete 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
返回值
| 类型 | 必备 |
| Promise<SetTabBarBadgeSuccess> | 否 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | errMsg | string | 是 | | | |
|
参见
uni.removeTabBarBadge(options)
移除 tabBar 某一项右上角的文本
removeTabBarBadge 兼容性
| Web | 微信小程序 | Android | iOS | iOS(Vapor) | HarmonyOS | HarmonyOS(Vapor) |
| 4.0 | 4.41 | 3.91 | 4.11 | x | 4.61 | 5.11 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| options | RemoveTabBarBadgeOptions | 是 | | | |
|
RemoveTabBarBadgeSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
RemoveTabBarBadgeFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errCode | number | 是 | | | 错误码 |
| 合法值 | 描述 | | 100 | TabBar 不存在 | | 200 | 参数错误 |
|
| errSubject | string | 是 | | | 统一错误主题(模块)名称 |
| data | any | 否 | | | 错误信息中包含的数据 |
| cause | Error | 否 | | | 源错误信息,可以包含多个错误,详见SourceError |
| errMsg | string | 是 | | | |
RemoveTabBarBadgeComplete 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
返回值
| 类型 | 必备 |
| Promise<RemoveTabBarBadgeSuccess> | 否 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | errMsg | string | 是 | | | |
|
参见
uni.setTabBarStyle(options)
动态设置 tabBar 的整体样式
setTabBarStyle 兼容性
| Web | 微信小程序 | Android | iOS | iOS(Vapor) | HarmonyOS | HarmonyOS(Vapor) |
| 4.0 | 4.41 | 3.91 | 4.11 | x | 4.61 | 5.11 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| options | SetTabBarStyleOptions | 是 | | | |
|
SetTabBarStyleSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
SetTabBarStyleFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errCode | number | 是 | | | 错误码 |
| 合法值 | 描述 | | 100 | TabBar 不存在 | | 200 | 参数错误 |
|
| errSubject | string | 是 | | | 统一错误主题(模块)名称 |
| data | any | 否 | | | 错误信息中包含的数据 |
| cause | Error | 否 | | | 源错误信息,可以包含多个错误,详见SourceError |
| errMsg | string | 是 | | | |
SetTabBarStyleComplete 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
返回值
| 类型 | 必备 |
| Promise<SetTabBarStyleSuccess> | 否 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | errMsg | string | 是 | | | |
|
参见
uni.setTabBarItem(options)
动态设置 tabBar 某一项的内容
setTabBarItem 兼容性
| Web | 微信小程序 | Android | iOS | iOS(Vapor) | HarmonyOS | HarmonyOS(Vapor) |
| 4.0 | 4.41 | 3.91 | 4.11 | x | 4.61 | 5.11 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| options | SetTabBarItemOptions | 是 | | | |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | index | number | 是 | | | tabBar 的哪一项,从左边算起,索引从0开始 | | text | string | 否 | | | tab 上按钮文字 | | iconPath | string | 否 | | | 图片路径 | | selectedIconPath | string | 否 | | | 选中时的图片路径 | | pagePath | string | 否 | | | 页面绝对路径 | | iconfont | SetTabBarItemIconFontOptions | 否 | | | 字体图标,优先级高于 iconPath | | 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | text | string | 是 | | | 字库 Unicode 码 | | selectedText | string | 是 | | | 选中后字库 Unicode 码 | | fontSize | string | 否 | | | 字体图标字号(px) | | color | string | 否 | | | 字体图标颜色 | | selectedColor | string | 否 | | | 字体图标选中颜色 |
| | visible | boolean | 否 | | | tab 是否显示 | | success | (result: SetTabBarItemSuccess) => void | 否 | | | 接口调用成功的回调函数 | | fail | (result: SetTabBarItemFail) => void | 否 | | | 接口调用失败的回调函数 | | complete | (result: SetTabBarItemComplete) => void | 否 | | | 接口调用结束的回调函数(调用成功、失败都会执行) |
|
SetTabBarItemSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
SetTabBarItemFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errCode | number | 是 | | | 错误码 |
| 合法值 | 描述 | | 100 | TabBar 不存在 | | 200 | 参数错误 |
|
| errSubject | string | 是 | | | 统一错误主题(模块)名称 |
| data | any | 否 | | | 错误信息中包含的数据 |
| cause | Error | 否 | | | 源错误信息,可以包含多个错误,详见SourceError |
| errMsg | string | 是 | | | |
SetTabBarItemComplete 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | |
返回值
| 类型 | 必备 |
| Promise<SetTabBarItemSuccess> | 否 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | errMsg | string | 是 | | | |
|
参见
注意:小程序上无法通过本API动态添加和删除tabbar的item。
通用类型
GeneralCallbackResult
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | | | 错误信息 |
Bug & Tips
- 自 4.23 起,在非 tabbar 页面调用以上 API 会报错:hideTabBar:fail not TabBar page
- uni-app-x harmony 暂不支持隐藏TabBarItem