Taro.setTabBarBadge(option)
Adds text in the upper right corner of a tabBar item.
Type
(option: Option) => Promise<CallbackResult>
Parameters
Option
| Property | Type | Required | Description |
|---|---|---|---|
| index | number | Yes | Specifies which item of tabBar, starting from the left |
| text | string | Yes | The text to be displayed, which will be displayed as "..." if it is more than 4 characters. |
| complete | (res: CallbackResult) => void | No | The callback function used when the API call completed (always executed whether the call succeeds or fails) |
| fail | (res: CallbackResult) => void | No | The callback function for a failed API call |
| success | (res: CallbackResult) => void | No | The callback function for a successful API call |
Sample Code
Taro.setTabBarBadge({
index: 0,
text: '1'
})
API Support
| API | WeChat Mini-Program | H5 | React Native |
|---|---|---|---|
| Taro.setTabBarBadge | ✔️ | ✔️ | ✔️ |