---
name: "setNavigationBarColor"
mode: "kit"
versionRequirements:
  - { name: "MiniKit", version: "1.0.0" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "setNavigationBarColor - 设置页面导航条颜色"
---

## setNavigationBarColor

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

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

设置页面导航条颜色

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `frontColor` | `string` | 是 | - | `1.0.0` | 前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000 |
| `backgroundColor` | `string` | 是 | - | `1.0.0` | 背景颜色值，有效值为十六进制颜色 |
| `animation` | `NavigationBarColorAnimationInfo` | 是 | - | `1.0.0` | 动画效果 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `() => void` | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 引用对象

##### `interface` NavigationBarColorAnimationInfo

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `duration` | `number` | `1.0.0` | 动画变化时间，单位 ms |
| `timingFunc` | `string` | `1.0.0` | 动画变化方式 'linear'	动画从头到尾的速度是相同的 'easeIn'	动画以低速开始 'easeOut'	动画以低速结束 'easeInOut'	动画以低速开始和结束 |


### 示例代码

#### Demo

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

setNavigationBarColor({
  frontColor: "#000000",
  backgroundColor: "#FFFFFF",
  animation: { duration: 300, timingFunc: "easeInOut" },
  success: data => { console.log(data); },
  fail: error => { console.error(error); },
});
```