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

## setTabBarStyle

> [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

Dynamically set the overall tabBar style

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `color` | `string` | Yes | - | `1.0.0` | Default text color on the tab |
| `selectedColor` | `string` | Yes | - | `1.0.0` | Text color when the tab is selected |
| `backgroundColor` | `string` | Yes | - | `1.0.0` | Tab background color |
| `borderStyle` | `string` | Yes | - | `1.0.0` | Top border color of the tabBar; supports only black/white |
| `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 { setTabBarStyle } from '@ray-js/ray'

setTabBarStyle({
  color: "#999999",
  selectedColor: "#000000",
  backgroundColor: "#FFFFFF",
  borderStyle: "black",
  success: data => { console.log(data); },
  fail: error => { console.error(error); },
});
```