# @appboxo/react-native-sdk 中文文档

规范地址：https://npmcn.com/package/%40appboxo/react-native-sdk/

版本：1\.16\.0
npm 元数据更新时间：2026-09-24T07:07:37.612Z
中文译文更新时间：2026-11-06T11:19:23.036Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40appboxo/react-native-sdk
原文对照：https://npmcn.com/package/%40appboxo/react-native-sdk/?lang=original
项目主页：https://github.com/Appboxo/react-native-sdk#readme
源码仓库：https://github.com/Appboxo/react-native-sdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：354 kB，60 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react \>=16\.8\.1，react-native \>=0\.60\.0-rc\.0
- 首次发布：2020-06-23T12:33:14.565Z
- 最新版本发布：2026-09-24T07:07:36.852Z
- 近 30 天下载量：3656（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：73（近 12 个月 14 个）

## 中文简介

BoxosDK 本地反应插件

## 安装

```sh
npm install @appboxo/react-native-sdk
```

也可以使用：`pnpm add @appboxo/react-native-sdk`、`yarn add @appboxo/react-native-sdk`、`bun add @appboxo/react-native-sdk`

## README

## Boxo SDK 反应原生

在Boxo SDK上为IOS和Android装有反应原生包装.

开始 :

```shell
yarn add @appboxo/react-native-sdk 
```

或者说

```shell
npm install @appboxo/react-native-sdk 
```

IOS 下一个:

```shell
cd ios && pod install
```

用法 :

```tsx
import React from 'react';
import Boxo from '@appboxo/react-native-sdk';
import { StyleSheet, View, Button } from 'react-native';

export default function App() {

  React.useEffect(() => {
    Boxo.setConfig('[client_id]', false);  //set your Boxo client_id, sandbox mode (by default is "false")
  }, [])

  const handleOpenMiniapp = () => {
    Boxo.openMiniapp('[miniapp_id]', {'key': 'value'});  //launch miniapp by id with data as {[key: string]: any} | undefined that is sent to miniapp.
  }

  return (
    <View style={styles.container}>
      <Button
        color="#841584"
        title="Launch miniapp"
        onPress={handleOpenMiniapp}
        accessibilityLabel="Launch miniapp"
    />
    </View>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'center',
    backgroundColor: '#fff',
    justifyContent: 'center',
  },
});
```

倾听小型应用生命周期事件:

> 重要
> 
> 1.0.8+版本的小型应用生命周期事件

```tsx
import React from 'react';
import Boxo from '@appboxo/react-native-sdk';
import { StyleSheet, View, Button } from 'react-native';

export default function App() {

  React.useEffect(() => {
    Boxo.setConfig('[client_id]', false);  //set your Boxo client_id, sandbox mode
    
    const subscription = Boxo.lifecycleHooksListener({
      onLaunch: (appId: string) => console.log('onLaunch', appId),  // called when the miniapp will launch with openMiniapp(...)
      onResume: (appId: string) => console.log('onResume', appId),  // called when the miniapp will start interacting with the user
      onPause: (appId: string) => console.log('onPause', appId),    // called when clicked close button in miniapp or when destroyed miniapp activity
      onClose: (appId: string) => console.log('onClose', appId),    // called when the miniapp loses foreground state
      onAuth: (appId: string) => console.log('onAuth', appId),    // called when authorization flow starts
      onError: (appId: string, error: string) => console.log('onError', appId, error),  // handle error
    });

    return () => subscription();
  }, [])

  const handleOpenMiniapp = () => {
    Boxo.openMiniapp('[miniapp_id]');  //launch miniapp by id
  }

  return (
    <View style={styles.container}>
      <Button
        color="#841584"
        title="Launch miniapp"
        onPress={handleOpenMiniapp}
        accessibilityLabel="Launch miniapp"
    />
    </View>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'center',
    backgroundColor: '#fff',
    justifyContent: 'center',
  },
});
```

## 常见问题

### @appboxo/react-native-sdk 是什么？

BoxosDK 本地反应插件

### 如何安装 @appboxo/react-native-sdk？

在项目目录运行 npm install @appboxo/react-native-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.8\.1）、react-native（\>=0\.60\.0-rc\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @appboxo/react-native-sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @appboxo/react-native-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @appboxo/react-native-sdk 可以商用吗？

@appboxo/react-native-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @appboxo/react-native-sdk 的下载量有多少？

根据 npm 官方下载统计，@appboxo/react-native-sdk 在 2026/10/07 – 2026/11/05 这 30 天内被下载 3,656 次，日均约 122 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @appboxo/react-native-sdk 还在维护吗？

最新版本 1\.16\.0 发布于 2026/09/24（1 个月前）；至今共发布 73 个版本，其中过去 12 个月发布了 14 个；首次发布于 2020/06/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。