- Release Notes and Announcements
- Product Introduction
- Purchasing Guide
- Getting Started
- Introduction to Platform Functions
- Guidelines for Code Integration
- Get Demo and SDK
- Android
- iOS
- Flutter
- Guildlines for Mini Program Development
- Mini program introduction and development environment
- Mini program code composition
- Guidance
- Framework
- Components
- API
- API Overview
- Fundamentals
- Routing
- Redirect
- Forwarding
- Interface
- Network
- Data Caching
- Data Analysis
- canvas
- Worker
- Media
- WXML
- File
- Device
- Contact
- Vibration
- Battery Level
- Screen
- Memory
- Device Orientation
- Accessibility
- Network
- Keyboard
- Phone number
- Accelerometer
- Compass
- Gyroscope
- SMS
- Code scanning
- Encryption
- NFC－Ndef
- NFC－NfcA
- NFC－NfcB
- NFC－NfcF
- NFC－NfcV
- WiFi
- Calendar
- Clipboard
- NFC－getNFCAdapter
- NFC－NFCAdapter
- NFC－IsoDep
- NFC－MifareClassic
- NFC－MifareUltralight
- Bluetooth - Low Energy Central Device
- Bluetooth - Low Energy Peripheral Device
- Bluetooth - Beacon
- Bluetooth - General
- Location
- Open APIs
- Custom APIs
- Sensitive APIs
- H5 Real-Time communication
- JS SDK
- Base Library
- IDE Operation Instructions
- FAQs
- API Documentation
- Application APIs
- Management-Sensitive APIs
- Platform Management APIs
- Mini Program APIs
- DescribeMNPOfflinePackageURL
- CreateMNPDomainACL
- CreateMNP
- ReleaseMNPVersion
- CreateMNPApproval
- DescribeMNPAllStageVersions
- DeleteMNP
- DescribeMNP
- DescribeMNPList
- DescribeMNPCategory
- DescribeMNPPreview
- ModifyMNP
- ConfigureMNPPreview
- ProcessMNPApproval
- CreateMNPVersion
- DescribeMNPVersion
- DescribeMNPReleasedVersionHistory
- RemoveMNP
- RollbackMNPVersion
- Team Management APIs
- Global Domain Management APIs
- User Management APIs
- Role Management APIs
- Sensitive API-related APIs
- Agreements
- Release Notes and Announcements
- Product Introduction
- Purchasing Guide
- Getting Started
- Introduction to Platform Functions
- Guidelines for Code Integration
- Get Demo and SDK
- Android
- iOS
- Flutter
- Guildlines for Mini Program Development
- Mini program introduction and development environment
- Mini program code composition
- Guidance
- Framework
- Components
- API
- API Overview
- Fundamentals
- Routing
- Redirect
- Forwarding
- Interface
- Network
- Data Caching
- Data Analysis
- canvas
- Worker
- Media
- WXML
- File
- Device
- Contact
- Vibration
- Battery Level
- Screen
- Memory
- Device Orientation
- Accessibility
- Network
- Keyboard
- Phone number
- Accelerometer
- Compass
- Gyroscope
- SMS
- Code scanning
- Encryption
- NFC－Ndef
- NFC－NfcA
- NFC－NfcB
- NFC－NfcF
- NFC－NfcV
- WiFi
- Calendar
- Clipboard
- NFC－getNFCAdapter
- NFC－NFCAdapter
- NFC－IsoDep
- NFC－MifareClassic
- NFC－MifareUltralight
- Bluetooth - Low Energy Central Device
- Bluetooth - Low Energy Peripheral Device
- Bluetooth - Beacon
- Bluetooth - General
- Location
- Open APIs
- Custom APIs
- Sensitive APIs
- H5 Real-Time communication
- JS SDK
- Base Library
- IDE Operation Instructions
- FAQs
- API Documentation
- Application APIs
- Management-Sensitive APIs
- Platform Management APIs
- Mini Program APIs
- DescribeMNPOfflinePackageURL
- CreateMNPDomainACL
- CreateMNP
- ReleaseMNPVersion
- CreateMNPApproval
- DescribeMNPAllStageVersions
- DeleteMNP
- DescribeMNP
- DescribeMNPList
- DescribeMNPCategory
- DescribeMNPPreview
- ModifyMNP
- ConfigureMNPPreview
- ProcessMNPApproval
- CreateMNPVersion
- DescribeMNPVersion
- DescribeMNPReleasedVersionHistory
- RemoveMNP
- RollbackMNPVersion
- Team Management APIs
- Global Domain Management APIs
- User Management APIs
- Role Management APIs
- Sensitive API-related APIs
- Agreements
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) |
Yes
No
Was this page helpful?