This page is translated by Google Cloud Translation API

Switch to Chinese

uni.setTabBarItem(OBJECT)

Dynamically set the content of a tabBar item

Platform Difference Description

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快手小程序	京东小程序
√	√	√	√ (DingTalk MiniApp not supported)	√	√	√	√	√

OBJECT parameter description:

Attribute	Type	Default	Required	Description	Platform Difference
index	number		which item of	tabBar, counting from the left
text	String		No	button text on the tab
iconPath	String		No	Image path, the icon size is limited to 40kb, and the recommended size is 81px * 81px. When the position is top, this parameter is invalid. WeChat MiniApp 2.7.0+, Alipay MiniApp support network pictures, other platforms do not support network pictures
selectedIconPath	String		No	The image path when selected, the icon size is limited to 40kb, the recommended size is 81px * 81px, when the position is top, this parameter is invalid
pagePath	String		No	The absolute path of the page must be defined first in pages, the replaced pagePath will not become a normal page (you still need to use uni.switchTab to jump Transfer)	App (2.8.4+), H5 (2.8.4+)
visible	Boolean	true	No	Whether the item is displayed	App (3.2.10+), H5 (3.2.10+)
iconfont	Object		No	Font icon, priority is higher than iconPath	App (3.4.4+)
success	Function		No	Callback function for successful interface call
fail	Function		No	Callback function for interface call failure
complete	Function		No	The callback function of the end of the interface call (it will be executed when the call succeeds or fails)

iconfont parameter description:

Attribute	Type	Description
text	String	Font Unicode code
selectedText	String	Unicode code of selected font
fontSize	String	Font icon font size (px)
color	String	font icon color
selectedColor	String	font icon selected color

Example Code

uni.setTabBarItem({
  index: 0,
  text: 'text',
  iconPath: '/path/to/iconPath',
  selectedIconPath: '/path/to/selectedIconPath'
})

Note: When setting the iconfont property, the pages.json iconfontSrc needs to specify the font file, refer to the configuration below

// pages.json
{
  "tabBar": {
    "iconfontSrc":"static/iconfont.ttf",
    "list": [
      {
        "pagePath": "pages/index/index",
        "text": "Tab1",
        "iconfont": {
          "text": "\ue102",
          "selectedText": "\ue103",
          "fontSize": "17px",
          "color": "#000000",
          "selectedColor": "#0000ff"
        }
      }
    ]
  }
}

uni.setTabBarStyle(OBJECT)

Dynamically set the overall style of tabBar

Platform Difference Description

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快手小程序	京东小程序
√	√	√	√	√	√	√	√	√

OBJECT parameter description:

Attribute	Type	Default	Required	Description
color	String		No	The default color of the text on the tab, HexColor
selectedColor	String		No	The color of the selected text on the tab, HexColor
backgroundColor	String		No	background color of tab, HexColor
backgroundImage	String		No	The image background. Support setting local images or creating linear gradients such as, priority is higher than backgroundColor, only supported by App 2.7.1+
backgroundRepeat	String		No	The tiling method of the background image. repeat: the background image is tiled vertically and horizontally; repeat-x: the background image is tiled horizontally, stretched vertically; repeat-y: the background image is tiled vertically, stretched horizontally; no-repeat : The background image is stretched both vertically and horizontally. By default no-repeat is used. Only supported by App 2.7.1+
borderStyle	String		No	The color of the border on the tabBar, only support black/white
midButton	Object		No	The middle button is only valid when the list item is even Details. HBuilderX 3.6.9+
success	Function		No	Callback function for successful interface call
fail	Function		No	Callback function for interface call failure
complete	Function		No	The callback function of the end of the interface call (it will be executed when the call succeeds or fails)

backgroundImage creates a linear gradient description

backgroundImage: linear-gradient(to top, #a80077, #66ff00);

Radial-gradient is currently not supported.

Currently only supports gradients of two colors, and the gradient direction is as follows:

• to right: Gradient from left to right
• to left: Gradient from right to left
• to bottom: Gradient from top to bottom
• to top: Gradient from bottom to top
• to bottom right: from the upper left corner to the lower right corner
• to top left: from the bottom right corner to the top left corner

Example Code

uni.setTabBarStyle({
  color: '#FF0000',
  selectedColor: '#00FF00',
  backgroundColor: '#0000FF',
  borderStyle: 'white'
})

uni.hideTabBar(OBJECT)

hide tabBar

Platform Difference Description

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快手小程序	京东小程序
√	√	√	√	√	√	√	√	√

OBJECT parameter description:

Attribute	Type	Default	Required	Description
animation	boolean	false	否	是否需要动画效果，仅微信小程序、支付宝小程序、百度小程序、抖音小程序、飞书小程序、QQ小程序、快手小程序、京东小程序支持
success	Function		No	Callback function for successful interface call
fail	Function		No	Callback function for interface call failure
complete	Function		No	The callback function of the end of the interface call (it will be executed when the call succeeds or fails)

uni.showTabBar(OBJECT)

show tabBar

Platform Difference Description

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快手小程序	京东小程序
√	√	√	√	√	√	√	√	√

OBJECT parameter description:

Attribute	Type	Default	Required	Description
animation	boolean	false	否	是否需要动画效果，仅微信小程序、支付宝小程序、百度小程序、抖音小程序、飞书小程序、QQ小程序、快手小程序、京东小程序支持
success	Function		No	Callback function for successful interface call
fail	Function		No	Callback function for interface call failure
complete	Function		No	The callback function of the end of the interface call (it will be executed when the call succeeds or fails)

uni.setTabBarBadge(OBJECT)

Add text to the upper right corner of an item in the tabBar.

Platform Difference Description

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快手小程序	京东小程序
√	√	√	√	√	√	√	√	√

OBJECT parameter description:

Parameter	Type	Required	Description
index	Number	which item of	tabBar, counting from the left
text	String	Yes	the displayed text, no more than 3 half-width characters
success	Function	No	Callback function for successful interface call
fail	Function	No	Callback function for interface call failure
complete	Function	No	The callback function for the end of the interface call (it will be executed when the call succeeds or fails)

Example Code

uni.setTabBarBadge({
  index: 0,
  text: '1'
})

uni.removeTabBarBadge(OBJECT)

Remove the text in the upper right corner of an item in the tabBar.

Platform Difference Description

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快手小程序	京东小程序
√	√	√	√	√	√	√	√	√

OBJECT parameter description:

Parameter	Type	Required	Description
index	Number	which item of	tabBar, counting from the left
success	Function	No	Callback function for successful interface call
fail	Function	No	Callback function for interface call failure
complete	Function	No	The callback function for the end of the interface call (it will be executed when the call succeeds or fails)

uni.showTabBarRedDot(OBJECT)

Displays a red dot in the upper right corner of an item in the tabBar.

Platform Difference Description

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快手小程序	京东小程序
√	√	√	√	√	√	√	√	√

OBJECT parameter description:

Parameter	Type	Required	Description
index	Number	which item of	tabBar, counting from the left
success	Function	No	Callback function for successful interface call
fail	Function	No	Callback function for interface call failure
complete	Function	No	The callback function for the end of the interface call (it will be executed when the call succeeds or fails)

uni.hideTabBarRedDot(OBJECT)

Hide the red dot in the upper right corner of an item in the tabBar.

Platform Difference Description

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快手小程序	京东小程序
√	√	√	√	√	√	√	√	√

OBJECT parameter description:

Parameter	Type	Required	Description
index	Number	which item of	tabBar, counting from the left
success	Function	No	Callback function for successful interface call
fail	Function	No	Callback function for interface call failure
complete	Function	No	The callback function for the end of the interface call (it will be executed when the call succeeds or fails)

uni.onTabBarMidButtonTap(CALLBACK)

Listen to the click event of the middle button

Platform Difference Description

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快手小程序	京东小程序
√（HBuilderX 2.3.4+）	√	x	x	x	x	x	x	x

Tip

• tabbar is native, higher level than the front element
• [uni-app plug-in market](https://ext.dcloud.net.cn/search?q=%E5%BA%95%E9%83%A8%E5%9B%BE%E6%A0%87% E8%8F%9C%E5%8D%95) There is a packaged front-end tabbar, but the performance is not as good as the original tabbar
• If you want a tabbar with a + sign in the middle, create a new uni-app project in HBuilderX and select the bottom tab template
• Most of the above APIs that operate the tabbar need to be used after the tabbar is rendered, and avoid using it before the tabbar is not initialized