uni.setTabBarBadge(options) @settabbarbadge

# uni.setTabBarBadge(options)

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

# # Parameters

name	type	required	default	description
options	SetTabBarBadgeOptions	YES	-	-

# # SetTabBarBadgeOptions Values

name	type	optinal	default	description
index	number	YES	-	tabBar的哪一项，从左边算起，索引从0开始
text	string	YES	-	显示的文本，不超过 3 个半角字符
success	(result: AsyncApiSuccessResult) => void	NO	-	接口调用成功的回调函数
fail	(result: SetTabBarError) => void	NO	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	NO	-	接口调用结束的回调函数（调用成功、失败都会执行）

# # SetTabBarError Values

name	type	optinal	default	description
errCode	100 \| 200	YES	-	错误码 - 100: TabBar 不存在 - 200: 参数错误
errSubject	string	YES	-	统一错误主题（模块）名称
errMsg	string	YES	-	统一错误描述信息
data	any	NO	-	错误信息中包含的数据
name	string	YES	-	-
message	string	YES	-	-

# # AsyncApiResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # Return value

Type	optinal
Promise<AsyncApiSuccessResult>	NO

# # AsyncApiSuccessResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # See also

setTabBarBadge

Related Bug

# uni.removeTabBarBadge(options)

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

# # Parameters

name	type	required	default	description
options	RemoveTabBarBadgeOptions	YES	-	-

# # RemoveTabBarBadgeOptions Values

name	type	optinal	default	description
index	number	YES	-	tabBar的哪一项，从左边算起，索引从0开始
success	(result: AsyncApiSuccessResult) => void	NO	-	接口调用成功的回调函数
fail	(result: SetTabBarError) => void	NO	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	NO	-	接口调用结束的回调函数（调用成功、失败都会执行）

# # SetTabBarError Values

name	type	optinal	default	description
errCode	100 \| 200	YES	-	错误码 - 100: TabBar 不存在 - 200: 参数错误
errSubject	string	YES	-	统一错误主题（模块）名称
errMsg	string	YES	-	统一错误描述信息
data	any	NO	-	错误信息中包含的数据
name	string	YES	-	-
message	string	YES	-	-

# # AsyncApiResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # Return value

Type	optinal
Promise<AsyncApiSuccessResult>	NO

# # AsyncApiSuccessResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # See also

removeTabBarBadge

Related Bug

# uni.setTabBarItem(options)

动态设置 tabBar 某一项的内容

# # Parameters

name	type	required	default	description
options	SetTabBarItemOptions	YES	-	-

# # SetTabBarItemOptions Values

name	type	optinal	default	description
index	number	YES	-	tabBar 的哪一项，从左边算起，索引从0开始
text	string	NO	-	tab 上按钮文字
iconPath	string	NO	-	图片路径
selectedIconPath	string	NO	-	选中时的图片路径
pagePath	string	NO	-	页面绝对路径
iconfont	SetTabBarItemIconFontOptions	NO	-	字体图标，优先级高于 iconPath
visible	boolean	NO	-	tab 是否显示
success	(result: AsyncApiSuccessResult) => void	NO	-	接口调用成功的回调函数
fail	(result: SetTabBarError) => void	NO	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	NO	-	接口调用结束的回调函数（调用成功、失败都会执行）

# # SetTabBarItemIconFontOptions Values

name	type	optinal	default	description
text	string	YES	-	字库 Unicode 码
selectedText	string	YES	-	选中后字库 Unicode 码
fontSize	string	NO	-	字体图标字号(px)
color	string	NO	-	字体图标颜色
selectedColor	string	NO	-	字体图标选中颜色

# # SetTabBarError Values

name	type	optinal	default	description
errCode	100 \| 200	YES	-	错误码 - 100: TabBar 不存在 - 200: 参数错误
errSubject	string	YES	-	统一错误主题（模块）名称
errMsg	string	YES	-	统一错误描述信息
data	any	NO	-	错误信息中包含的数据
name	string	YES	-	-
message	string	YES	-	-

# # AsyncApiResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # Return value

Type	optinal
Promise<AsyncApiSuccessResult>	NO

# # AsyncApiSuccessResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # See also

setTabBarItem

Related Bug

# uni.setTabBarStyle(options)

动态设置 tabBar 的整体样式

# # Parameters

name	type	required	default	description
options	SetTabBarStyleOptions	YES	-	-

# # SetTabBarStyleOptions Values

name	type	optinal	default	description
color	string (string.ColorString)	NO	-	tab 上的文字默认颜色
selectedColor	string (string.ColorString)	NO	-	tab 上的文字选中时的颜色
backgroundColor	string (string.ColorString)	NO	-	tab 的背景色
backgroundImage	string	NO	-	图片背景
backgroundRepeat	"repeat" \| "repeat-x" \| "repeat-y" \| "no-repeat"	NO	-	背景图平铺方式 - repeat: 背景图片在垂直方向和水平方向平铺 - repeat-x: 背景图片在水平方向平铺，垂直方向拉伸 - repeat-y: 背景图片在垂直方向平铺，水平方向拉伸 - no-repeat: 背景图片在垂直方向和水平方向都拉伸
borderStyle	string	NO	-	tabbar上边框的颜色
midButton	MidButtonOptions	NO	-	tabbar 中间按钮仅在 list 项为偶数时有效
success	(result: AsyncApiSuccessResult) => void	NO	-	接口调用成功的回调函数
fail	(result: SetTabBarError) => void	NO	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	NO	-	接口调用结束的回调函数（调用成功、失败都会执行）

# # MidButtonOptions Values

name	type	optinal	default	description
width	string	NO	-	中间按钮的宽度，tabBar 其它项为减去此宽度后平分，默认值为与其它项平分宽度。默认 80px
height	string	NO	-	中间按钮的高度，可以大于 tabBar 高度，达到中间凸起的效果。默认 50px
text	string	NO	-	中间按钮的文字
iconPath	string	NO	-	中间按钮的图片路径
iconWidth	string	NO	-	图片宽度（高度等比例缩放）。默认 24px
backgroundImage	string	NO	-	中间按钮的背景图片路径
iconfont	MidButtonIconFont	NO	-	字体图标，优先级高于 iconPath

# # MidButtonIconFont Values

name	type	optinal	default	description
text	string	NO	-	字库 Unicode 码
selectedText	string	NO	-	选中后字库 Unicode 码
fontSize	string	NO	-	字体图标字号(px)
color	string	NO	-	字体图标颜色
selectedColor	string	NO	-	字体图标选中颜色

# # SetTabBarError Values

name	type	optinal	default	description
errCode	100 \| 200	YES	-	错误码 - 100: TabBar 不存在 - 200: 参数错误
errSubject	string	YES	-	统一错误主题（模块）名称
errMsg	string	YES	-	统一错误描述信息
data	any	NO	-	错误信息中包含的数据
name	string	YES	-	-
message	string	YES	-	-

# # AsyncApiResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # Return value

Type	optinal
Promise<AsyncApiSuccessResult>	NO

# # AsyncApiSuccessResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # See also

setTabBarStyle

Related Bug

# uni.hideTabBar(options?)

隐藏 tabBar

# # Parameters

name	type	required	default	description
options	HideTabBarOptions	NO	-	-

# # HideTabBarOptions Values

name	type	optinal	default	description
animation	boolean	NO	-	是否需要动画效果
success	(result: AsyncApiSuccessResult) => void	NO	-	接口调用成功的回调函数
fail	(result: SetTabBarError) => void	NO	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	NO	-	接口调用结束的回调函数（调用成功、失败都会执行）

# # SetTabBarError Values

name	type	optinal	default	description
errCode	100 \| 200	YES	-	错误码 - 100: TabBar 不存在 - 200: 参数错误
errSubject	string	YES	-	统一错误主题（模块）名称
errMsg	string	YES	-	统一错误描述信息
data	any	NO	-	错误信息中包含的数据
name	string	YES	-	-
message	string	YES	-	-

# # AsyncApiResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # Return value

Type	optinal
Promise<AsyncApiSuccessResult>	NO

# # AsyncApiSuccessResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # See also

hideTabBar

Related Bug

# uni.showTabBar(options?)

显示 tabBar

# # Parameters

name	type	required	default	description
options	ShowTabBarOptions	NO	-	-

# # ShowTabBarOptions Values

name	type	optinal	default	description
animation	boolean	NO	-	是否需要动画效果
success	(result: AsyncApiSuccessResult) => void	NO	-	接口调用成功的回调函数
fail	(result: SetTabBarError) => void	NO	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	NO	-	接口调用结束的回调函数（调用成功、失败都会执行）

# # SetTabBarError Values

name	type	optinal	default	description
errCode	100 \| 200	YES	-	错误码 - 100: TabBar 不存在 - 200: 参数错误
errSubject	string	YES	-	统一错误主题（模块）名称
errMsg	string	YES	-	统一错误描述信息
data	any	NO	-	错误信息中包含的数据
name	string	YES	-	-
message	string	YES	-	-

# # AsyncApiResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # Return value

Type	optinal
Promise<AsyncApiSuccessResult>	NO

# # AsyncApiSuccessResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # See also

showTabBar

Related Bug

# uni.showTabBarRedDot(options)

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

# # Parameters

name	type	required	default	description
options	ShowTabBarRedDotOptions	YES	-	-

# # ShowTabBarRedDotOptions Values

name	type	optinal	default	description
index	number	YES	-	tabBar的哪一项，从左边算起，索引从0开始
success	(result: AsyncApiSuccessResult) => void	NO	-	接口调用成功的回调函数
fail	(result: SetTabBarError) => void	NO	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	NO	-	接口调用结束的回调函数（调用成功、失败都会执行）

# # SetTabBarError Values

name	type	optinal	default	description
errCode	100 \| 200	YES	-	错误码 - 100: TabBar 不存在 - 200: 参数错误
errSubject	string	YES	-	统一错误主题（模块）名称
errMsg	string	YES	-	统一错误描述信息
data	any	NO	-	错误信息中包含的数据
name	string	YES	-	-
message	string	YES	-	-

# # AsyncApiResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # Return value

Type	optinal
Promise<AsyncApiSuccessResult>	NO

# # AsyncApiSuccessResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # See also

showTabBarRedDot

Related Bug

# uni.hideTabBarRedDot(options)

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

# # Parameters

name	type	required	default	description
options	HideTabBarRedDotOptions	YES	-	-

# # HideTabBarRedDotOptions Values

name	type	optinal	default	description
index	number	YES	-	tabBar的哪一项，从左边算起，索引从0开始
success	(result: AsyncApiSuccessResult) => void	NO	-	接口调用成功的回调函数
fail	(result: SetTabBarError) => void	NO	-	接口调用失败的回调函数
complete	(result: AsyncApiResult) => void	NO	-	接口调用结束的回调函数（调用成功、失败都会执行）

# # SetTabBarError Values

name	type	optinal	default	description
errCode	100 \| 200	YES	-	错误码 - 100: TabBar 不存在 - 200: 参数错误
errSubject	string	YES	-	统一错误主题（模块）名称
errMsg	string	YES	-	统一错误描述信息
data	any	NO	-	错误信息中包含的数据
name	string	YES	-	-
message	string	YES	-	-

# # AsyncApiResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # Return value

Type	optinal
Promise<AsyncApiSuccessResult>	NO

# # AsyncApiSuccessResult Values

name	type	optinal	default	description
errMsg	string	YES	-	-

# # See also

hideTabBarRedDot

Related Bug

# # General type

# # GeneralCallbackResult

name	type	optinal	default	description
errMsg	string	YES	-	错误信息

products

HBuilderX uni-app uniCloud uniMPsdk 5+Runtime uni-id uni-search uniPay uniPush uni-verify sms uni-starter uni-admin uni-upgrade-center uni-im uni-ai uni-cms

Operating services

uni-AD uni-stat uni-portal Safety topic

Developer Services

forum dashboard

Docs

uni-app uniCloud native-support HBuilderX

Ecosystem

Marketplace OAuth

About： DCloud Jobs Terms of service Privacy policy acceptable use policy

# uni.setTabBarBadge(options)

# # Parameters

# # SetTabBarBadgeOptions Values

# # SetTabBarError Values

# # AsyncApiResult Values

# # Return value

# # AsyncApiSuccessResult Values

# # See also

# uni.removeTabBarBadge(options)

# # Parameters

# # RemoveTabBarBadgeOptions Values

# # SetTabBarError Values

# # AsyncApiResult Values

# # Return value

# # AsyncApiSuccessResult Values

# # See also

# uni.setTabBarItem(options)

# # Parameters

# # SetTabBarItemOptions Values

# # SetTabBarItemIconFontOptions Values

# # SetTabBarError Values

# # AsyncApiResult Values

# # Return value

# # AsyncApiSuccessResult Values

# # See also

# uni.setTabBarStyle(options)

# # Parameters

# # SetTabBarStyleOptions Values

# # MidButtonOptions Values

# # MidButtonIconFont Values

# # SetTabBarError Values

# # AsyncApiResult Values

# # Return value

# # AsyncApiSuccessResult Values

# # See also

# uni.hideTabBar(options?)

# # Parameters

# # HideTabBarOptions Values

# # SetTabBarError Values

# # AsyncApiResult Values

# # Return value

# # AsyncApiSuccessResult Values

# # See also

# uni.showTabBar(options?)

# # Parameters

# # ShowTabBarOptions Values

# # SetTabBarError Values

# # AsyncApiResult Values

# # Return value

# # AsyncApiSuccessResult Values

# # See also

# uni.showTabBarRedDot(options)

# # Parameters

# # ShowTabBarRedDotOptions Values

# # SetTabBarError Values

# # AsyncApiResult Values

# # Return value

# # AsyncApiSuccessResult Values

# # See also

# uni.hideTabBarRedDot(options)

# # Parameters

# # HideTabBarRedDotOptions Values

# # SetTabBarError Values

# # AsyncApiResult Values

# # Return value

# # AsyncApiSuccessResult Values

# # See also

# # General type

# # GeneralCallbackResult

On This Page