---
name: "preloadPanel"
mode: "kit"
versionRequirements:
  - { name: "BizKit", version: "3.0.0" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "preloadPanel - 面板预下载"
---

## preloadPanel

> [VERSION] BizKit >= 3.0.0 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

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

### 描述

面板预下载

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `deviceId` | `string` | 是 | - | `3.0.0` | 设备id |
| `extraInfo` | `PanelExtraParams` | 否 | - | `3.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` PanelExtraParams

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `productId` | `string` | `3.0.0` | 产品id |
| `productVersion` | `string` | `3.0.0` | 产品版本 |
| `i18nTime` | `string` | `3.0.0` | 面板多语言时间戳 |
| `bizClientId` | `string` | `3.0.0` | 容器ID 可能是uiid的值也可能是miniAppId的值 |
| `uiType` | `string` | `3.0.0` | 包类型 RN RN类型 SMART_MINIPG 小程序类型 |
| `uiPhase` | `string` | `3.0.0` | 包发布状态 |


### 示例代码

#### Demo

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

preloadPanel({
  deviceId: "xx",
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```