# @getcello/cello-react-native 中文文档

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

版本：0\.17\.0
npm 元数据更新时间：2026-11-11T20:13:59.945Z
中文译文更新时间：2026-11-16T05:53:45.872Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：628 kB，33 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18\.0\.0
- 运行依赖：0 个
- peer 依赖：react \*，react-native \*
- 首次发布：2024-04-27T12:23:02.256Z
- 最新版本发布：2026-11-11T20:13:59.772Z
- 近 30 天下载量：52582（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：52（近 12 个月 11 个）

## 中文简介

反应原生包装以桥接iOS和Android SDK

## 安装

```sh
npm install @getcello/cello-react-native
```

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

## README

# @ getcello/ cello- react- native

> 反应原生包装器来连接我们的iOS和Android SDK

### 🏠 [网站](https://www.cello.so/)

### 📚 [开发者 Docs](https://docs.cello.so/docs/cello-for-react-native)

* * *

-   📂 [主页](https://github.com/getcello/cello-react-native#readme)
    -   [安装](https://npmcn.com/package/%40getcello/cello-react-native/#readme-installation)
        -   [机器人](https://npmcn.com/package/%40getcello/cello-react-native/#readme-android)
            -   [Android: 自动链接到 React Industrial v0.59 及以下](https://npmcn.com/package/%40getcello/cello-react-native/#readme-android-automatic-linking-with-react-native-v059-and-below)
            -   [Android: 手动链接到 React Industrial v0.59 及以下](https://npmcn.com/package/%40getcello/cello-react-native/#readme-android-manual-linking-with-react-native-v059-and-below)
            -   [Android: 设置](https://npmcn.com/package/%40getcello/cello-react-native/#readme-android-setup)
            -   [Android: 权限](https://npmcn.com/package/%40getcello/cello-react-native/#readme-android-permissions)
        -   [监督办](https://npmcn.com/package/%40getcello/cello-react-native/#readme-ios)
            -   [iOS: 手动链接到 React Industrial v0.59 及以下](https://npmcn.com/package/%40getcello/cello-react-native/#readme-ios-manual-linking-with-react-native-v059-and-below)
            -   [iOS: 设置](https://npmcn.com/package/%40getcello/cello-react-native/#readme-ios-setup)
        -   [博览](https://npmcn.com/package/%40getcello/cello-react-native/#readme-expo)
    -   [通用方法](https://npmcn.com/package/%40getcello/cello-react-native/#readme-methods)
    -   [使用量](https://npmcn.com/package/%40getcello/cello-react-native/#readme-usage)
    -   [解决问题](https://npmcn.com/package/%40getcello/cello-react-native/#readme-troubleshooting)
    -   [作者](https://npmcn.com/package/%40getcello/cello-react-native/#readme-author)
    -   [显示您的支持](https://npmcn.com/package/%40getcello/cello-react-native/#readme-show-your-support)
    -   [许可证](https://npmcn.com/package/%40getcello/cello-react-native/#readme--license)

* * *

## 安装

```sh
npm install @getcello/cello-react-native
```

或者说

```sh
yarn add @getcello/cello-react-native
```

* * *

### 机器人

如果您正在使用 React Industrial v. 0. 60 或以上,则库会自动链接而无需采取任何步骤.

#### Android: 自动链接到 React Industrial v0.59 及以下

```sh
react-native link @getcello/cello-react-native
```

#### Android: 手动链接到 React Industrial v0.59 及以下

-   在代码下添加到 `android/settings.gradle`

```Gradle
include ':cello-react-native'
project(':cello-react-native').projectDir = new File(rootProject.projectDir, '../node_modules/@getcello/cello-react-native/android')
```

-   然后编辑 `android/app/build.gradle`内部 `dependencies` 在最下方添加

```Gradle
implementation project(':cello-react-native')
```

#### Android: 设置

-   在行后添加到 `android/app/src/main/java/com/YOUR_APP/app/MainApplication.java` 内部 `onCreate` 方法,替换 `productId` 财务报告和审定财务报表 `token` 可见于您的 [设置页面](https://portal.cello.so/)。 。 。 .

```java
import com.celloreactnative.CelloReactNativeModule; //  <-- Add this line

// ...

@Override
public void onCreate() {
  super.onCreate();
  SoLoader.init(this, /* native exopackage */ false);

  // ...

  CelloReactNativeModule.initialize("productId", "token"); // <-- Add this line

  // ...
}
```

-   打开 `android/build.gradle` 更改 `minSdkVersion` 改为 **21国**, (中文(简体) ), `compileSdkVersion` 至少改为 **页:1** 财务报告和审定财务报表 `targetSdkVersion` 至少改为 **页:1**

```Gradle
buildscript {
    // ...
    ext {
        buildToolsVersion = "29.0.2"
        minSdkVersion = 21 // <-- Here
        compileSdkVersion = 34 // <-- Here
        targetSdkVersion = 34 // <-- Here
    }
    // ...
}
```

-   单位 `android/build.gradle` 确保 `com.android.tools.build:gradle` 版本大于 `8.1.1`

```Gradle
dependencies {
    classpath("com.android.tools.build:gradle:8.1.1")
    // ...
}
```

#### Android: 权限

你需要包括 [互联网](http://developer.android.com/reference/android/Manifest.permission.html#INTERNET) 权限在 `android/app/src/main/AndroidManifest.xml`数字 :

```xml
<uses-permission android:name="android.permission.INTERNET" />
```

* * *

### 监督办

IOS的 Cello 需要一个 **最低iOS版本15.**

```sh
cd ios
pod install
cd ..
```

如果您正在使用 React Industrial v. 0. 60 或以上,则库会自动链接而无需采取任何步骤.

IOS SDK (英语:`CelloSDK.xcframework`这个包裹里面的船, 所以没有什么可补充的 `Podfile`。不要添加 `CelloSDK` 通过 `Podfile` 或 Swift 软件包管理器 : 应用程序可以得到两个框架副本 。 与一个 `pod 'CelloSDK'` 线条, `pod install` 停止为 `target has frameworks with conflicting names: cellosdk.xcframework`; 删除该行.

#### iOS: 设置

-   打开 `ios/AppDelegate.m` 然后增加以下代码:
    
-   在文件上方添加以下内容:
    

```Objective-C
#import "AppDelegate.h"
#import <React/RCTBridge.h>
#import <React/RCTBundleURLProvider.h>
#import <React/RCTRootView.h>
// ...
#import <CelloReactNative.h> // <-- Add This
```

-   内部 `didFinishLaunchingWithOptions` 在此之前 `return YES` 添加, 请记住替换 `productId` 财务报告和审定财务报表 `token` 可见于您的 [凯洛门户](https://portal.cello.so/)数字 :

```Objective-C
  // ...
  self.window.rootViewController = rootViewController;

  [CelloReactNative initialize:for@"productId" with:@"token"]; // <-- Add this (Remember to replace strings with your product id and token)

  return YES;
  }
```

* * *

### 博览

如果您正在使用 Expo, 您可以使用内置插件 .

在安装此软件包后, 添加 [配置插件](https://docs.expo.io/guides/config-plugins/) 页:1 [`plugins`](https://docs.expo.io/versions/latest/config/app/#plugins) 您的数组 `app.json` 或者说 `app.config.js`数字 :

```json
{
  "expo": {
    "plugins": ["@getcello/cello-react-native"]
  }
}
```

该插件提供了设置环境的道具. 每次更换道具或插件,都需要重建(并 `prebuild`(原始内容存档于2018-10-10). ). 本地应用. 如果没有添加额外的属性,则使用默认值.

-   `env` (单位:千美元)_字符串_:设定为您想要的环境,例如: `prod`, (中文(简体) ), `sandbox`. 可选。 默认为 `prod`。 。 。 .

```json
{
  "expo": {
    "plugins": [
      [
        "@getcello/cello-react-native",
        {
          "env": "sandbox"
        }
      ]
    ]
  }
}
```

接下来,重建您的应用程序,如 ["添加风俗本土代码"](https://docs.expo.io/workflow/customizing/) 向导.

* * *

## 方法

## 导入

### `import Cello from '@getcello/cello-react-native';`

* * *

### `Cello.initialize()`

初始化您产品中的 Cello 推荐组件

### API 样式

这个 `initialize` 方法支持两种调用样式:

#### 1\. 基于对象的API(建议 - 新建)

```javascript
import Cello from '@getcello/cello-react-native';

const config = await Cello.initialize({
  productId: 'your-product-id',
  token: 'your-token',
  productUserDetails: {
    firstName: 'John',
    lastName: 'Doe',
    fullName: 'John Doe',
    email: 'john.doe@example.com',
  },
});
```

#### 2\. 基于争论的API(Legacy - 仍然支持)

```javascript
const config = await Cello.initialize('your-product-id', 'your-token');
```

### 初始化选项

| 财产 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| 产品标识 | 字符串 | 对 | Cello门户网站上的你产品ID |
| 符号 | 字符串 | 对 | 用户认证符 |
| 产品用户详情 | 产品用户详情 | 没有 | 用户细节对象(见下文) |

### 产品用户详情

有用户信息的可选对象 :

| 财产 | 类型 | 说明 |
| --- | --- | --- |
| 第一个Name | 字符串 | 用户名 |
| 最后一个Name | 字符串 | 用户姓 |
| 完整Name | 字符串 | 用户的全名 |
| 电子邮件 | 字符串 | 用户的电子邮件地址 |

### 回返

`Promise<configuration>`

* * *

### `Cello.showFab()`

显示启动推荐组件的浮动动作按钮或书签

* * *

### `Cello.hideFab()`

隐藏启动推荐组件的浮动动作按钮或书签

* * *

### `Cello.openWidget()`

打开移交组件

* * *

### `Cello.hideWidget()`

关闭移交部分

* * *

### `Cello.shutdown()`

关闭移交部分

* * *

### `Cello.getActiveUcc()`

获取当前登录用户的 ucc 和邀请链接的方法 .

### 回返

`{ ucc, link }`

* * *

### `Cello.getCampaignConfig()`

获得你产品竞选配置的方法.

### 回返

`Promise<campaignConfig | null>`

返回具有以下属性的运动配置对象 :

-   `primaryCurrency` (字符串):主货币代码
-   `revenuePercentage` (数目):作为奖励支付的指定新收入的百分比
-   `rewardCap` (数目):每个转介机构可获得的最高奖励
-   `newSignupBonus` (数目):为鼓励更多分享的报名提供额外奖励
-   `newPurchaseBonus` (数目):额外奖励购买,鼓励更多分享
-   `newUserDiscountMonth` (数目):新用户获得折扣的时间长短
-   `newUserDiscountPercentage` (数目):新用户得到的折扣

回返 `null` 如果 SDK 没有初始化,或者没有竞选配置.

* * *

### `Cello.updateToken(token)`

更新标志并进行验证.

### 选项

| 类型 | 类型 | 需求 |
| --- | --- | --- |
| 符号 | 字符串 | 对 |

### 回返

`Promise<configuration>`

* * *

### `Cello.changeLanguage(language)`

一种在不重新初始化的情况下在运行时更改移案部分语言的方法.

### 选项

| 类型 | 类型 | 需求 |
| --- | --- | --- |
| 语言 | 字符串 | 对 |

* * *

## 使用量

[检查示例应用程序](https://github.com/getcello/cello-react-native/blob/main/example/src/App.tsx)

* * *

## 解决问题

-   #### 这个工程使用AndroidX依赖性,但“android.useAndroidX”属性没有启用 .
    
    -   启用 `jetifier`,将这两行添加到您的 `gradle.properties` 文件 :
        
        ```
        android.useAndroidX=true
        android.enableJetifier=true
        ```
        
-   #### 当Android应用持续停止(E/AndroidRuntime:FATAL EXCEPTION: mqt native modules)时
    
    -   将这些行添加到 `dependencies` 内 `./android/app/build.gradle`数字 :
        
        ```
        implementation 'androidx.appcompat:appcompat:1.6.1'
        ```
        
-   #### 当使用 Jest 的测试未提及“ 无法读取未定义的属性 ” 时
    
    -   做一个 `jest.mock` 用于库的函数 :
        
        ```
        // jest/setup.ts
        jest.mock('@getcello/cello-react-native', () => jest.fn());
        ```
        

* * *

## 作者

👤 **塞罗( Cello )[https://www.cello.so/ (中文(简体) )](https://www.cello.so/)(中文(简体) )**

## 显示您的支持

如果这个计划能帮助你的话,就给你一个!

## 许可证

这个项目是 [麻省理工学院](https://npmcn.com/package/%40getcello/cello-react-native/LICENSE) 有执照.

* * *

由QQ 创建 [塞罗](https://cello.so/)

## 常见问题

### @getcello/cello-react-native 是什么？

反应原生包装以桥接iOS和Android SDK

### 如何安装 @getcello/cello-react-native？

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

### @getcello/cello-react-native 支持 TypeScript 吗？

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

### @getcello/cello-react-native 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @getcello/cello-react-native 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>= 18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @getcello/cello-react-native 可以商用吗？

@getcello/cello-react-native 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @getcello/cello-react-native 的下载量有多少？

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

### @getcello/cello-react-native 还在维护吗？

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

