uni.showTabBar(options?) @showtabbar

展示全部

# uni.showTabBar(options?)

显示 tabBar

# showTabBar 兼容性

Web	Android	iOS
4.0	3.91	4.11

# 参数

名称

类型

必填

默认值

兼容性

描述

options

ShowTabBarOptions

否

名称	类型	必备	默认值	兼容性	描述
animation	boolean	否	-	-	是否需要动画效果
success	(result: AsyncApiSuccessResult) => void	否	-	-	接口调用成功的回调函数
fail	(result: SetTabBarFail) => void	否	-	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	否	-	-	接口调用结束的回调函数（调用成功、失败都会执行）

# SetTabBarFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

错误码

合法值	兼容性	描述
100	-	TabBar 不存在
200	-	参数错误

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# AsyncApiResult 的属性值

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	-	-

# 返回值

类型	必备
Promise<AsyncApiSuccessResult>	否

# 参见

# uni.hideTabBar(options?)

隐藏 tabBar

# hideTabBar 兼容性

Web	Android	iOS
4.0	3.91	4.11

# 参数

名称

类型

必填

默认值

兼容性

描述

options

HideTabBarOptions

否

名称	类型	必备	默认值	兼容性	描述
animation	boolean	否	-	-	是否需要动画效果
success	(result: AsyncApiSuccessResult) => void	否	-	-	接口调用成功的回调函数
fail	(result: SetTabBarFail) => void	否	-	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	否	-	-	接口调用结束的回调函数（调用成功、失败都会执行）

# SetTabBarFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

错误码

合法值	兼容性	描述
100	-	TabBar 不存在
200	-	参数错误

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# AsyncApiResult 的属性值

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	-	-

# 返回值

类型	必备
Promise<AsyncApiSuccessResult>	否

# 参见

# uni.showTabBarRedDot(options)

显示 tabBar 某一项的右上角的红点

# showTabBarRedDot 兼容性

Web	Android	iOS
4.0	3.91	4.11

# 参数

名称

类型

必填

默认值

兼容性

描述

options

ShowTabBarRedDotOptions

是

名称	类型	必备	默认值	兼容性	描述
index	number	是	-	-	tabBar的哪一项，从左边算起，索引从0开始
success	(result: AsyncApiSuccessResult) => void	否	-	-	接口调用成功的回调函数
fail	(result: SetTabBarFail) => void	否	-	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	否	-	-	接口调用结束的回调函数（调用成功、失败都会执行）

# SetTabBarFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

错误码

合法值	兼容性	描述
100	-	TabBar 不存在
200	-	参数错误

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# AsyncApiResult 的属性值

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	-	-

# 返回值

类型	必备
Promise<AsyncApiSuccessResult>	否

# 参见

# uni.hideTabBarRedDot(options)

隐藏 tabBar 某一项的右上角的红点

# hideTabBarRedDot 兼容性

Web	Android	iOS
4.0	3.91	4.11

# 参数

名称

类型

必填

默认值

兼容性

描述

options

HideTabBarRedDotOptions

是

名称	类型	必备	默认值	兼容性	描述
index	number	是	-	-	tabBar的哪一项，从左边算起，索引从0开始
success	(result: AsyncApiSuccessResult) => void	否	-	-	接口调用成功的回调函数
fail	(result: SetTabBarFail) => void	否	-	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	否	-	-	接口调用结束的回调函数（调用成功、失败都会执行）

# SetTabBarFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

错误码

合法值	兼容性	描述
100	-	TabBar 不存在
200	-	参数错误

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# AsyncApiResult 的属性值

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	-	-

# 返回值

类型	必备
Promise<AsyncApiSuccessResult>	否

# 参见

# uni.setTabBarBadge(options)

为 tabBar 某一项的右上角添加文本

# setTabBarBadge 兼容性

Web	Android	iOS
4.0	3.91	4.11

# 参数

名称

类型

必填

默认值

兼容性

描述

options

SetTabBarBadgeOptions

是

名称	类型	必备	默认值	兼容性	描述
index	number	是	-	-	tabBar的哪一项，从左边算起，索引从0开始
text	string	是	-	-	显示的文本，不超过 3 个半角字符
success	(result: AsyncApiSuccessResult) => void	否	-	-	接口调用成功的回调函数
fail	(result: SetTabBarFail) => void	否	-	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	否	-	-	接口调用结束的回调函数（调用成功、失败都会执行）

# SetTabBarFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

错误码

合法值	兼容性	描述
100	-	TabBar 不存在
200	-	参数错误

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# AsyncApiResult 的属性值

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	-	-

# 返回值

类型	必备
Promise<AsyncApiSuccessResult>	否

# 参见

# uni.removeTabBarBadge(options)

移除 tabBar 某一项右上角的文本

# removeTabBarBadge 兼容性

Web	Android	iOS
4.0	3.91	4.11

# 参数

名称

类型

必填

默认值

兼容性

描述

options

RemoveTabBarBadgeOptions

是

名称	类型	必备	默认值	兼容性	描述
index	number	是	-	-	tabBar的哪一项，从左边算起，索引从0开始
success	(result: AsyncApiSuccessResult) => void	否	-	-	接口调用成功的回调函数
fail	(result: SetTabBarFail) => void	否	-	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	否	-	-	接口调用结束的回调函数（调用成功、失败都会执行）

# SetTabBarFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

错误码

合法值	兼容性	描述
100	-	TabBar 不存在
200	-	参数错误

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# AsyncApiResult 的属性值

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	-	-

# 返回值

类型	必备
Promise<AsyncApiSuccessResult>	否

# 参见

# uni.setTabBarStyle(options)

动态设置 tabBar 的整体样式

# setTabBarStyle 兼容性

Web	Android	iOS
4.0	3.91	4.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: AsyncApiSuccessResult) => void

否

接口调用成功的回调函数

fail

(result: SetTabBarFail) => void

否

接口调用失败的回调函数

complete

(result: AsyncApiResult) => void

否

接口调用结束的回调函数（调用成功、失败都会执行）

# SetTabBarFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

错误码

合法值	兼容性	描述
100	-	TabBar 不存在
200	-	参数错误

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# AsyncApiResult 的属性值

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	-	-

# 返回值

类型	必备
Promise<AsyncApiSuccessResult>	否

# 参见

# uni.setTabBarItem(options)

动态设置 tabBar 某一项的内容

# setTabBarItem 兼容性

Web	Android	iOS
4.0	3.91	4.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: AsyncApiSuccessResult) => void

否

接口调用成功的回调函数

fail

(result: SetTabBarFail) => void

否

接口调用失败的回调函数

complete

(result: AsyncApiResult) => void

否

接口调用结束的回调函数（调用成功、失败都会执行）

# SetTabBarFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

错误码

合法值	兼容性	描述
100	-	TabBar 不存在
200	-	参数错误

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# AsyncApiResult 的属性值

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	-	-

# 返回值

类型	必备
Promise<AsyncApiSuccessResult>	否

# 参见

# 通用类型

# GeneralCallbackResult

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	-	错误信息

# Bug & Tips

自 4.23 起，在非 tabbar 页面调用已上 API 会报错：hideTabBar:fail not TabBar page

运营产品

uni-ad uni统计 uni发行 uni安全专题

开发者服务

问答社区开发者后台

技术文档

uni-app文档 uniCloud文档原生开发者支持文档 HBuilder文档

生态服务

插件市场 OAuth用户开放平台

关于我们： DCloud官网案例需求墙许可协议加入我们赞助我们

联系我们：商务合作：bd@dcloud.io 广告合作：uniad@dcloud.io

DCloud.io 数字天堂（北京）网络技术有限公司是

HTML5中国产业联盟发起单位

京公网安备：11010802035340号

国家信息安全等级保护三级，证书编号：11010813802-20001