Skip to main content
Version: 3.x

Taro.setTabBarBadge(option)

Adds text in the upper right corner of a tabBar item.

Reference

Type

(option: Option) => Promise<CallbackResult>

Parameters

Option

PropertyTypeRequiredDescription
indexnumberYesSpecifies which item of tabBar, starting from the left
textstringYesThe text to be displayed, which will be displayed as "..." if it is more than 4 characters.
complete(res: CallbackResult) => voidNoThe callback function used when the API call completed (always executed whether the call succeeds or fails)
fail(res: CallbackResult) => voidNoThe callback function for a failed API call
success(res: CallbackResult) => voidNoThe callback function for a successful API call

Sample Code

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

API Support

APIWeChat Mini-ProgramH5React Native
Taro.setTabBarBadge✔️✔️✔️