TabBar

showTabBar

TIP

The API usage is as follows: wx.showTabBar(Object object)

• Functional description: Display tabBar.
• Parameters and descriptions: Object object

Properties	Type	Default value	Required	Description
animation	boolean	false	No	Do you need animation effects?
success	Function	-	No	Callback function for successful interface call
fail	Function	-	No	Callback function for failed interface call
complete	Function	-	No	Callback function for interface call completion (executed regardless of success or failure)

hideTabBar

TIP

The API usage is as follows: wx.hideTabBar(Object object)

• Functional description: Hide tabBar.
• Parameters and descriptions: Object object

Properties	Type	Default value	Required	Description
animation	boolean	false	No	Do you need animation effects?
success	Function	-	No	Callback function for successful interface call
fail	Function	-	No	Callback function for failed interface call
complete	Function	-	No	Callback function for interface call completion (executed regardless of success or failure)

setTabBarStyle

TIP

The API usage is as follows: wx.setTabBarStyle(Object object)

• Functional description: Dynamically set the overall style of tabBar.
• Parameters and descriptions: Object object

Properties	Type	Default value	Required	Description
color	string	-	No	The default color of text on the tab, HexColor
selectedColor	string	-	No	The color of the text on the tab when it is selected, HexColor
backgroundColor	string	-	No	The background color of the tab, HexColor
borderStyle	string	-	No	The color of the top border of the tab, only supports black/white
success	Function	-	No	Callback function for successful interface call
fail	Function	-	No	Callback function for failed interface call
complete	Function	-	No	Callback function for interface call completion (executed regardless of success or failure)

setTabBarItem

TIP

The API usage is as follows: wx.setTabBarItem(Object object)

• Functional description: Dynamically set the content of a tabBar item.
• Parameters and descriptions: Object object

Properties	Type	Default value	Required	Description
index	number	-	Yes	Which item of the tabBar, counting from the left
text	string	-	No	Button text on the tab
iconPath	string	-	No	Image path, icon size limit is 40kb, recommended size is 81px * 81px, when position is top, this parameter is invalid
selectedIconPath	string	-	No	Image path when selected, icon size limit is 40kb, recommended size is 81px * 81px, when position is top, this parameter is invalid
success	Function	-	No	Callback function for successful interface call
fail	Function	-	No	Callback function for failed interface call
complete	Function	-	No	Callback function for interface call completion (executed regardless of success or failure)

• Sample code:

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

showTabBarRedDot

TIP

The API usage is as follows: wx.showTabBarRedDot(Object object)

• Functional description: Show the red dot in the upper right corner of a tabBar item.
• Parameters and descriptions: Object object

Properties	Type	Default value	Required	Description
index	number	-	Yes	Which item of the tabBar, counting from the left
success	Function	-	No	Callback function for successful interface call
fail	Function	-	No	Callback function for failed interface call
complete	Function	-	No	Callback function for interface call completion (executed regardless of success or failure)

hideTabBarRedDot

TIP

The API usage is as follows: wx.hideTabBarRedDot(Object object)

• Functional description: Hide the red dot in the upper right corner of a tabBar item.
• Parameters and descriptions: Object object

Properties	Type	Default value	Required	Description
index	number	-	Yes	Which item of the tabBar, counting from the left
success	Function	-	No	Callback function for successful interface call
fail	Function	-	No	Callback function for failed interface call
complete	Function	-	No	Callback function for interface call completion (executed regardless of success or failure)

setTabBarBadge

TIP

The API usage is as follows: wx.setTabBarBadge(Object object)

• Functional description: Add text to the upper right corner of a tabBar item.
• Parameters and descriptions: Object object

Properties	Type	Default value	Required	Description
index	number	-	Yes	Which item of the tabBar, counting from the left
text	string	-	No	If the displayed text exceeds 4 characters, it will be displayed as ...
success	Function	-	No	Callback function for successful interface call
fail	Function	-	No	Callback function for failed interface call
complete	Function	-	No	Callback function for interface call completion (executed regardless of success or failure)

• Sample code:

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

removeTabBarBadge

TIP

The API usage is as follows: wx.removeTabBarBadge(Object object)

• Functional description: Add text to the upper right corner of a tabBar item.
• Parameters and descriptions: Object object

Properties	Type	Default value	Required	Description
index	number	-	Yes	Which item of the tabBar, counting from the left
success	Function	-	No	Callback function for successful interface call
fail	Function	-	No	Callback function for failed interface call
complete	Function	-	No	Callback function for interface call completion (executed regardless of success or failure)