# @appcues/react-native 中文文档 规范地址：https://npmcn.com/package/%40appcues/react-native/ 版本：5\.0\.10 npm 元数据更新时间：2026-10-15T17:55:47.935Z 中文译文更新时间：2026-11-06T11:24:43.305Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40appcues/react-native 原文对照：https://npmcn.com/package/%40appcues/react-native/?lang=original 项目主页：https://github.com/appcues/appcues-react-native-module#readme 源码仓库：https://github.com/appcues/appcues-react-native-module ## 关键信息（来自 npm 元数据） - 包体积（解压后）：114 kB，57 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - 运行依赖：0 个 - peer 依赖：react \*，react-native \* - 首次发布：2022-07-28T14:16:43.572Z - 最新版本发布：2026-10-15T17:55:47.729Z - 近 30 天下载量：33682（2026-10-07 至 2026-11-05，npm 官方下载统计） - 已发布版本数：66（近 12 个月 9 个） ## 中文简介 Android 和 iOS 移动应用程序的 Appcues React 原生模块 ## 安装 ```sh npm install @appcues/react-native ``` 也可以使用：`pnpm add @appcues/react-native`、`yarn add @appcues/react-native`、`bun add @appcues/react-native` ## README # 应用反应原生模块 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/appcues/appcues-react-native-module/tree/main.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/appcues/appcues-react-native-module/tree/main) [![npm](https://img.shields.io/npm/v/@appcues/react-native.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen)](https://www.npmjs.com/package/@appcues/react-native) [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/appcues/appcues-react-native-module/blob/main/LICENSE) Appcues React Introduct 模块允许您将 Appcues 体验整合到您的 React Introduct 应用程序中,用于iOS和Android设备. 这个本地模块是本地Appcues SDKs在React Introduction应用程序中的桥梁,它向Appcues API发送用户属性和事件,并检索和使Appcues内容基于这些属性和事件. - [应用反应原生模块](https://npmcn.com/package/%40appcues/react-native/#readme-appcues-react-native-module) - [开始](https://npmcn.com/package/%40appcues/react-native/#readme--getting-started) - [先决条件](https://npmcn.com/package/%40appcues/react-native/#readme-prerequisites) - [安装](https://npmcn.com/package/%40appcues/react-native/#readme-installation) - [标准安装](https://npmcn.com/package/%40appcues/react-native/#readme-standard-installation) - [部分](https://npmcn.com/package/%40appcues/react-native/#readme-segment) - [一次性设置](https://npmcn.com/package/%40appcues/react-native/#readme-one-time-setup) - [初始化 SDK](https://npmcn.com/package/%40appcues/react-native/#readme-initializing-the-sdk) - [配置主机环境](https://npmcn.com/package/%40appcues/react-native/#readme-configuring-hosting-environment) - [欧盟托管环境配置](https://npmcn.com/package/%40appcues/react-native/#readme-eu-hosting-environment-configuration) - [支持构建器预览和屏幕抓取](https://npmcn.com/package/%40appcues/react-native/#readme-supporting-builder-preview-and-screen-capture) - [启用推动通知](https://npmcn.com/package/%40appcues/react-native/#readme-enabling-push-notifications) - [识别用户](https://npmcn.com/package/%40appcues/react-native/#readme-identifying-users) - [跟踪屏幕和事件](https://npmcn.com/package/%40appcues/react-native/#readme-tracking-screens-and-events) - [悬疑工具提示](https://npmcn.com/package/%40appcues/react-native/#readme-anchored-tooltips) - [内在经验](https://npmcn.com/package/%40appcues/react-native/#readme-embedded-experiences) - [页:1](https://npmcn.com/package/%40appcues/react-native/#readme--documentation) - [实例](https://npmcn.com/package/%40appcues/react-native/#readme--examples) - [捐款](https://npmcn.com/package/%40appcues/react-native/#readme--contributing) - [许可证](https://npmcn.com/package/%40appcues/react-native/#readme--license) ## 开始 ### 先决条件 **原生反应** - 您的应用程序应当使用 React Native 0.73 或以上版本。 使用"博览会"的应用程序应当使用"50"或"50"以上版本. 从4.4.0版本开始,"新架构"得到充分的支持. **机器人** - 你的应用程序 `build.gradle` 必须有一个 `compileSdk` 第35个+和 `minSdk` ,并使用Android Gradle插件(AGP) 8.6+(建议8.8.2+). ``` android { compileSdk 35 defaultConfig { minSdk 21 } } ``` AGP 版本 < 8.8.2 (反应原生版本 < 0.79),您可能需要添加 [随行](https://developer.android.com/develop/ui/compose/tooling/lint) 给您的 `gradle.properties`数字 : ``` android.experimental.lint.version = 8.8.2 ``` **iOS系统** - 您的应用程序必须针对 iOS 11+ 安装 SDK, 而 iOS 13+ 来渲染 Appcues 内容 。 必要时更新iOS项目xcodeproj,以设定部署目标. 在申请中 `Podfile`,至少包括此最小版本. ```rb # Podfile platform :ios, '11.0' ``` ### 安装 在您的应用程序中添加 Appcues React 本地模块依赖性 。 标准安装或通过分块插件使用都有选择. #### 标准安装 1. 在您的应用程序的根目录中安装 Appcues React 本地模块 ```sh npm install --save @appcues/react-native # OR yarn add @appcues/react-native ``` 2. 根据你的申请 `ios` 文件夹,运行 ```sh pod install ``` 注意: 您不需要手动更新您的 Pod 文件以添加 Appcues . #### 部分 应用程序支持与 Session 合并 [分析-反应-内在](https://github.com/segmentio/analytics-react-native) 软件包。 要安装断面,请使用 [部件应用程序插件](https://github.com/appcues/segment-appcues-react-native)。 。 。 . ### 一次性设置 #### 初始化 SDK 当您的应用启动时, 应用 SDK 应该初始化 . ```js import * as Appcues from '@appcues/react-native'; await Appcues.setup('APPCUES_ACCOUNT_ID', 'APPCUES_APPLICATION_ID'); ``` 初始化 SDK 需要您提供两个值,即 Appcues 账户ID 和 Appcues 移动应用程序ID 。 这些值可以从您的 [应用程序设置](https://studio.appcues.com/settings/account)。请参考关于 [正在工作室注册您的移动应用程序](https://docs.appcues.com/article/848-registering-your-mobile-app-in-studio) 更多信息。 由于反应原生桥是同步的 `setup` 调用在调用后续 SDK 函数之前应当解决. #### 配置主机环境 默认情况下,Appcues SDK将向美国(美国)托管环境发送数据,不需要额外的配置. 要指定不同的托管环境,请通过 `apiHost` 财务报告和审定财务报表 `settingsHost` 选项. ##### 欧盟托管环境配置 ```js await Appcues.setup('APPCUES_ACCOUNT_ID', 'APPCUES_APPLICATION_ID', { apiHost: 'https://api.eu.appcues.net', settingsHost: 'https://fast.eu.appcues.com', }); ``` #### 支持构建器预览和屏幕抓取 在安装过程中,遵循下列步骤: [配置 URL 方案](https://github.com/appcues/appcues-react-native-module/blob/main/docs/URLSchemeConfiguring.md)。这对于完整的 Appcues 构建器体验、支持体验预览、屏幕捕获和调试是必要的. #### 启用推动通知 在 React Industrial app中,在iOS和Android的原生项目中配置了推进通知. 请参考当地文献: [iOS系统](https://appcues.github.io/appcues-ios-sdk/documentation/appcueskit/pushnotifications/) 财务报告和审定财务报表 [机器人](https://github.com/appcues/appcues-android-sdk/blob/main/docs/PushNotification.md) 更多细节。 这个 `example` 本寄存器中的目录包含一个包括推取通知支持的参考执行. 关于世博会的应用软件,请参见 [应用- expo- 模块](https://github.com/appcues/appcues-expo-module) 以整合推进通知. ### 识别用户 为了在正确的时间瞄准正确的用户内容,需要识别用户并发送有关他们的Appcues数据. 一个用户被识别出一个独特的ID. ```js // Identify a user Appcues.identify('my-user-id'); // Identify a user with property Appcues.identify('my-user-id', { Company: 'Appcues' }); ``` 在识别用户后,您可以选择将该用户与组关联. ```js // Associate a user with a group, optionally including group properties Appcues.group('group-id', { 'Plan Tier': 'standard' }); ``` 为了确保基于组信息最准确的内容针对性,建议在新用户确定后立即提供组信息. ### 跟踪屏幕和事件 事件是您的用户在您的应用程序中接受的“ 动作”, 从点击某个按钮到查看某个特定的屏幕都可以是任何东西 。 一旦安装并初始化了 Appcues React Natural 模块,您就可以使用以下方法开始跟踪屏幕和事件: ```js // Track event Appcues.track('Sent Message'); // Track event with property Appcues.track('Deleted Contact', { ID: 123 }); // Track screen Appcues.screen('Contact List'); // Track screen with property Appcues.screen('Contact Details', { 'Contact Reference': 'abc' }); ``` ### 悬疑工具提示 Anchored 工具提示使用元素瞄准来直接指向应用程序中的特定视图. 关于如何配置您应用程序对元素目标视图的更多信息,请参见: [Anchored 工具提示指南](https://github.com/appcues/appcues-react-native-module/blob/main/docs/AnchoredTooltips.md)。 。 。 . ### 内在经验 添加 `AppcuesFrameView` 在应用程序布局中支持嵌入式体验内容的示例,并采用非模式演示文稿。 有关如何配置应用程序布局以使用帧视图的更多信息,请参见: [配置一个配置FrameView](https://github.com/appcues/appcues-react-native-module/blob/main/docs/AppcuesFrameViewConfiguring.md)。 。 。 . ## 页:1 有关该模块的更多技术文件载于 [`docs` 目录](https://github.com/appcues/appcues-react-native-module/tree/main/docs)。完整的文件可在 [https://docs.appcues.com/ (中文(简体) )](https://docs.appcues.com/) ## 实例 这个 `example` 此寄存器中的目录包含完整的例子 iOS/Android app,用于为正确安装和使用 Appcues API提供参考. ## 捐款 见 [贡献指南](https://github.com/appcues/appcues-react-native-module/blob/main/CONTRIBUTING.md) 学习如何为发展做好准备以及如何为该项目作出贡献. ## 许可证 这个项目根据麻省理工学院的许可证获得许可。 见 [自由主义](https://github.com/appcues/appcues-react-native-module/blob/main/LICENSE) 更多信息. ## 常见问题 ### @appcues/react-native 是什么？ Android 和 iOS 移动应用程序的 Appcues React 原生模块 ### 如何安装 @appcues/react-native？ 在项目目录运行 npm install @appcues/react-native，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\*）、react-native（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @appcues/react-native 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @appcues/react-native 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @appcues/react-native 可以商用吗？ @appcues/react-native 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @appcues/react-native 的下载量有多少？ 根据 npm 官方下载统计，@appcues/react-native 在 2026/10/07 – 2026/11/05 这 30 天内被下载 33,682 次，日均约 1,123 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @appcues/react-native 还在维护吗？ 最新版本 5\.0\.10 发布于 2026/10/16（23 天前）；至今共发布 66 个版本，其中过去 12 个月发布了 9 个；首次发布于 2022/07/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。