---
name: "setTabBarBadge"
mode: "kit"
versionRequirements:
  - { name: "MiniKit", version: "1.0.0" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## setTabBarBadge

> [VERSION] MiniKit >= 1.0.0 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Add text to the top-right corner of a tabBar item

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `index` | `number` | Yes | - | `1.0.0` | Which tabBar item, counting from the left |
| `text` | `string` | Yes | - | `1.0.0` | Text to display; if longer than 4 characters, it shows as ... |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### Demo

```tsx
import { setTabBarBadge } from '@ray-js/ray'

setTabBarBadge({
  index: 0,
  text: "99",
  success: data => { console.log(data); },
  fail: error => { console.error(error); },
});
```