Release Notes and Announcements
Product Introduction
Purchase Guide
Getting Started
Plan Management
- Overview
- Console Account Management
- Storage Configuration
- Acceleration Configuration
- Branding Configurations
Platform Features
- Console Login
- Users and Permission System
- Mini Program Management
- Mini Game Management
- Superapp Management
- Commercialization
- Platform Management
- User Management
- Team Management
- Operations Management
- Security Center
Code Integration Guide
- Getting Demo and SDK
- Android
- iOS
- Flutter
- Superapp Server
- GUID Generation Rules
Mini Program Development Guide
- Mini Program Introduction and Development Environment
- Mini Program Code Composition
- Guide
- Framework
- Components
- API
- Server Backend
- JS SDK
- Base Library
- IDE Operation Instructions
Mini Game Development Guide
- Guide
- API
- Server Backend
Practice Tutorial
API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Superapp APIs
- Mini Program APIs
- Mini Game APIs
- Sensitive APIs
- Management-Sensitive APIs
- Platform Management APIs
- Other Console APIs
- Team Management APIs
- Global Domain Management APIs
- User Management APIs
- Role Management APIs
- Operation Management APIs
- Data Types
Agreements

TabBar

Focus Mode

Font Size

Last updated: 2025-03-20 18:01:56

showTabBar
The method of utilizing this API is wx.showTabBar(Object object).
Function Description: Unveils the tabBar.
Parameters and Description: Object object.
Attributes
Types
Default value
Required
Note
animation
boolean
false
Not required
Is animation effect necessary?
success
function
-
Not required
Callback function for successful interface invocation
fail
function
-
Not required
Callback function for unsuccessful interface invocation
complete
function
-
Not required
Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations)
hideTabBar
The usage method for this API is wx.hideTabBar(Object object)
Function Description: Conceals the tabBar.
Parameters and Description: Object object.
Attributes
Types
Default value
Required
Note
animation
boolean
false
Not required
Is animation effect necessary?
success
function
-
Not required
Callback function for successful interface invocation
fail
function
-
Not required
Callback function for unsuccessful interface invocation
complete
function
-
Not required
Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations)
setTabBarStyle
The usage method for this API is wx.setTabBarStyle(Object object)
Function Description: Dynamically configures the overall style of the tabBar.
Parameters and Description: Object object.
Attributes
Types
Default value
Required
Note
color
string
-
Not required
Default text color on the tab, HexColor
selectedColor
string
-
Not required
Text color on the tab when selected, HexColor
backgroundColor
string
-
Not required
Background color of the tab, HexColor
borderStyle
string
-
Not required
Color of the border on the tab, only supports black/white
success
function
-
Not required
Callback function for successful interface invocation
fail
function
-
Not required
Callback function for unsuccessful interface invocation
complete
function
-
Not required
Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations)
setTabBarItem
The usage method for this API is wx.setTabBarItem(Object object)
Function Description: Dynamically sets the content of a specific tabBar item.
Parameters and Description: Object object.
Attributes
Types
Default value
Required
Note
index
number
-
Supported
Which item of the tabBar, counting from the left
text
string
-
Not required
Text on the tab button
iconPath
string
-
Not required
Image path, the icon size is limited to 40kb, with a recommended dimension of 81px * 81px. This parameter is invalid when the position is set to 'top'.
selectedIconPath
string
-
Not required
Path of the image when selected, the icon size is limited to 40kb, with a recommended dimension of 81px * 81px. This parameter is invalid when the position is set to 'top'.
success
function
-
Not required
Callback function for successful interface invocation
fail
function
-
Not required
Callback function for unsuccessful interface invocation
complete
function
-
Not required
Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations)
Example Code
wx.setTabBarItem({
  index: 0,
  text: 'text',
  iconPath: '/path/to/iconPath',
  selectedIconPath: '/path/to/selectedIconPath'
})
showTabBarRedDot
The usage of this API is wx.showTabBarRedDot(Object object)
Function Description: Display the red dot at the top right corner of a tabBar item.
Parameters and Description: Object object.
Attributes
Types
Default value
Required
Note
index
number
-
Supported
Which item of the tabBar, counting from the left
success
function
-
Not required
Callback function for successful interface invocation
fail
function
-
Not required
Callback function for unsuccessful interface invocation
complete
function
-
Not required
Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations)
hideTabBarRedDot
The usage of this API is wx.hideTabBarRedDot(Object object)
Function Description: Hide the red dot at the top right corner of a tabBar item.
Parameters and Description: Object object.
Attributes
Types
Default value
Required
Note
index
number
-
Supported
Which item of the tabBar, counting from the left
success
function
-
Not required
Callback function for successful interface invocation
fail
function
-
Not required
Callback function for unsuccessful interface invocation
complete
function
-
Not required
Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations)
setTabBarBadge
The usage of this API is wx.setTabBarBadge(Object object)
Function Description: Add text to the top right corner of a tabBar item.
Parameters and Description: Object object.
Attributes
Types
Default value
Required
Note
index
number
-
Supported
Which item of the tabBar, counting from the left
text
string
-
Supported
The displayed text truncates to '...' if it exceeds 4 characters.
success
function
-
Not required
Callback function for successful interface invocation
fail
function
-
Not required
Callback function for unsuccessful interface invocation
complete
function
-
Not required
Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations)
Example Code
wx.setTabBarBadge({
  index: 0,
  text: '1'
})
removeTabBarBadge
The usage of this API is wx.removeTabBarBadge(Object object)
Function Description: Remove the text from the top right corner of a tabBar item.
Parameters and Description: Object object.
Attributes
Types
Default value
Required
Note
index
number
-
Supported
Which item of the tabBar, counting from the left
success
function
-
Not required
Callback function for successful interface invocation
fail
function
-
Not required
Callback function for unsuccessful interface invocation
complete
function
-
Not required
Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations)
﻿

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Tencent Cloud Super App as a Service

TabBar

showTabBar

hideTabBar

setTabBarStyle

setTabBarItem

showTabBarRedDot

hideTabBarRedDot

setTabBarBadge

removeTabBarBadge

Help and Support

Attributes	Types	Default value	Required	Note
animation	boolean	false	Not required	Is animation effect necessary?
success	function	-	Not required	Callback function for successful interface invocation
fail	function	-	Not required	Callback function for unsuccessful interface invocation
complete	function	-	Not required	Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations)