# 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
名称 类型 必备 默认值 兼容性 描述
animation boolean
是否需要动画效果
success (result: ShowTabBarSuccess) => void
接口调用成功的回调函数
fail (result: ShowTabBarFail) => void
接口调用失败的回调函数
complete (result: ShowTabBarComplete) => void
接口调用结束的回调函数(调用成功、失败都会执行)

# 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
名称 类型 必备 默认值 兼容性 描述
animation boolean
是否需要动画效果
success (result: HideTabBarSuccess) => void
接口调用成功的回调函数
fail (result: HideTabBarFail) => void
接口调用失败的回调函数
complete (result: HideTabBarComplete) => void
接口调用结束的回调函数(调用成功、失败都会执行)

# 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
名称 类型 必备 默认值 兼容性 描述
index number
tabBar的哪一项,从左边算起,索引从0开始
success (result: ShowTabBarRedDotSuccess) => void
接口调用成功的回调函数
fail (result: ShowTabBarRedDotFail) => void
接口调用失败的回调函数
complete (result: ShowTabBarRedDotComplete) => void
接口调用结束的回调函数(调用成功、失败都会执行)

# 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
名称 类型 必备 默认值 兼容性 描述
index number
tabBar的哪一项,从左边算起,索引从0开始
success (result: HideTabBarRedDotSuccess) => void
接口调用成功的回调函数
fail (result: HideTabBarRedDotFail) => void
接口调用失败的回调函数
complete (result: HideTabBarRedDotComplete) => void
接口调用结束的回调函数(调用成功、失败都会执行)

# 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
名称 类型 必备 默认值 兼容性 描述
index number
tabBar的哪一项,从左边算起,索引从0开始
text string
显示的文本,不超过 3 个半角字符
success (result: SetTabBarBadgeSuccess) => void
接口调用成功的回调函数
fail (result: SetTabBarBadgeFail) => void
接口调用失败的回调函数
complete (result: SetTabBarBadgeComplete) => void
接口调用结束的回调函数(调用成功、失败都会执行)

# 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
名称 类型 必备 默认值 兼容性 描述
index number
tabBar的哪一项,从左边算起,索引从0开始
success (result: RemoveTabBarBadgeSuccess) => void
接口调用成功的回调函数
fail (result: RemoveTabBarBadgeFail) => void
接口调用失败的回调函数
complete (result: RemoveTabBarBadgeComplete) => void
接口调用结束的回调函数(调用成功、失败都会执行)

# 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
名称 类型 必备 默认值 兼容性 描述
color string (string.ColorString)
tab 上的文字默认颜色
selectedColor string (string.ColorString)
tab 上的文字选中时的颜色
backgroundColor string (string.ColorString)
tab 的背景色
backgroundImage string
图片背景
backgroundRepeat string
背景图平铺方式
合法值 描述
repeat 背景图片在垂直方向和水平方向平铺
repeat-x 背景图片在水平方向平铺,垂直方向拉伸
repeat-y 背景图片在垂直方向平铺,水平方向拉伸
no-repeat 背景图片在垂直方向和水平方向都拉伸
borderColor string (string.ColorString)
tabbar上边框的颜色(优先级高于 borderStyle)
borderStyle string
tabbar上边框的颜色
合法值 描述
black
white
success (result: SetTabBarStyleSuccess) => void
接口调用成功的回调函数
fail (result: SetTabBarStyleFail) => void
接口调用失败的回调函数
complete (result: SetTabBarStyleComplete) => void
接口调用结束的回调函数(调用成功、失败都会执行)

# 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