# @appcues/capacitor 中文文档 规范地址：https://npmcn.com/package/%40appcues/capacitor/ 版本：5\.0\.7 npm 元数据更新时间：2026-10-21T21:25:54.394Z 中文译文更新时间：2026-11-06T11:25:06.050Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40appcues/capacitor 原文对照：https://npmcn.com/package/%40appcues/capacitor/?lang=original 项目主页：https://github.com/appcues/appcues-capacitor-plugin#readme 源码仓库：https://github.com/appcues/appcues-capacitor-plugin ## 关键信息（来自 npm 元数据） - 包体积（解压后）：66.6 kB，26 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - 运行依赖：0 个 - peer 依赖：@capacitor/core ^8\.0\.0 - 首次发布：2022-09-27T20:14:34.169Z - 最新版本发布：2026-10-21T21:25:54.140Z - 近 30 天下载量：32465（2026-10-07 至 2026-11-05，npm 官方下载统计） - 已发布版本数：47（近 12 个月 7 个） ## 中文简介 Capcitor插件在Ionic应用程序中将本地Android和iOS Appcues移动 SDK相接. ## 安装 ```sh npm install @appcues/capacitor ``` 也可以使用：`pnpm add @appcues/capacitor`、`yarn add @appcues/capacitor`、`bun add @appcues/capacitor` ## README # 辅助电容插件 [![CircleCI](https://circleci.com/gh/appcues/appcues-capacitor-plugin/tree/main.svg?style=shield)](https://circleci.com/gh/appcues/appcues-capacitor-plugin/tree/main) [![npm](https://img.shields.io/npm/v/@appcues/capacitor.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen)](https://www.npmjs.com/package/@appcues/capacitor) [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/appcues/appcues-capacitor-plugin/blob/main/LICENSE) Appcues Capacitor 插件允许您将 Appcues 体验整合到您的iOS和Android设备的Ionic apps中. 这个电容器是一个Ionic应用程序中本地的Appcues SDKs之间的桥梁,它向Appcues API发送用户属性和事件,并检索和使Appcues内容基于这些属性和事件. - [辅助电容插件](https://npmcn.com/package/%40appcues/capacitor/#readme-appcues-capacitor-plugin) - [开始](https://npmcn.com/package/%40appcues/capacitor/#readme--getting-started) - [先决条件](https://npmcn.com/package/%40appcues/capacitor/#readme-prerequisites) - [机器人](https://npmcn.com/package/%40appcues/capacitor/#readme-android) - [iOS系统](https://npmcn.com/package/%40appcues/capacitor/#readme-ios) - [安装](https://npmcn.com/package/%40appcues/capacitor/#readme-installation) - [一次性设置](https://npmcn.com/package/%40appcues/capacitor/#readme-one-time-setup) - [初始化 SDK](https://npmcn.com/package/%40appcues/capacitor/#readme-initializing-the-sdk) - [配置主机环境](https://npmcn.com/package/%40appcues/capacitor/#readme-configuring-hosting-environment) - [欧盟托管环境配置](https://npmcn.com/package/%40appcues/capacitor/#readme-eu-hosting-environment-configuration) - [支持构建器预览和屏幕抓取](https://npmcn.com/package/%40appcues/capacitor/#readme-supporting-builder-preview-and-screen-capture) - [启用推动通知](https://npmcn.com/package/%40appcues/capacitor/#readme-enabling-push-notifications) - [识别用户](https://npmcn.com/package/%40appcues/capacitor/#readme-identifying-users) - [跟踪屏幕和事件](https://npmcn.com/package/%40appcues/capacitor/#readme-tracking-screens-and-events) - [悬疑工具提示](https://npmcn.com/package/%40appcues/capacitor/#readme-anchored-tooltips) - [页:1](https://npmcn.com/package/%40appcues/capacitor/#readme--documentation) - [实例](https://npmcn.com/package/%40appcues/capacitor/#readme--examples) - [捐款](https://npmcn.com/package/%40appcues/capacitor/#readme--contributing) - [许可证](https://npmcn.com/package/%40appcues/capacitor/#readme--license) ## 开始 ### 先决条件 最新的软件包版本需要Capacitor 8. 使用 `@appcues/capacitor@5.0.6` 7号电容. #### 机器人 你的申请 `build.gradle` 必须有一个 `compileSdkVersion` 第36个+和 `minSdkVersion` 您的项目应该使用Android Gradle插件(AGP)的8.13+版本. ``` android { compileSdkVersion 36 defaultConfig { minSdkVersion 24 } } ``` 由于Jetpack Compose的SDK用法,AGP 8应用程序必须应用 `kotlin-android` 应用程序中的插件 `build.gradle`。AGP 9+默认启用内置的克特林,不应应用. ``` plugins { id 'com.android.application' id 'kotlin-android' // AGP 8 only } ``` #### iOS系统 您的应用程序必须瞄准iOS 15+. 必要时更新iOS项目xcodeproj,以设定部署目标. ### 安装 在您的应用的根目录中, 运行 : ```sh npm install @appcues/capacitor npx cap sync ``` 注意: 您不需要手动更新您的 Pod 文件以添加 Appcues . ### 一次性设置 #### 初始化 SDK 当您的应用启动时, 应用 SDK 应该初始化 . ```js import { Appcues } from '@appcues/capacitor'; Appcues.initialize({ accountId: 'APPCUES_ACCOUNT_ID', applicationId: '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) 更多信息. #### 配置主机环境 默认情况下,Appcues SDK将向美国(美国)托管环境发送数据,不需要额外的配置. 要指定不同的托管环境,请通过一个配置 `apiBasePath` 财务报告和审定财务报表 `settingsHost` 选项. ##### 欧盟托管环境配置 ```js Appcues.initialize({ accountId: 'APPCUES_ACCOUNT_ID', applicationId: 'APPCUES_APPLICATION_ID', config: { apiBasePath: 'https://api.eu.appcues.net', settingsHost: 'https://fast.eu.appcues.com', }, }); ``` #### 支持构建器预览和屏幕抓取 在安装过程中,遵循下列步骤: [配置 URL 方案](https://github.com/appcues/appcues-capacitor-plugin/blob/main/docs/URLSchemeConfiguring.md)。这对于完整的 Appcues 构建器体验、支持体验预览、屏幕捕获和调试是必要的. #### 启用推动通知 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` 本寄存器中的目录包含一个包括推取通知支持的参考执行. ### 识别用户 为了在正确的时间瞄准正确的用户内容,需要识别用户并发送有关他们的Appcues数据. 一个用户被识别出一个独特的ID. ```js // Identify a user Appcues.identify({ userId: 'my-user-id' }); // Identify a user with property Appcues.identify({ userId: 'my-user-id', properties: { company: 'Appcues' } }); ``` 在识别用户后,您可以选择将该用户与组关联. ```js // Associate a user with a group, optionally including group properties Appcues.group({ groupId: 'group-id', properties: { plan: 'standard' } }); ``` 为了确保基于组信息最准确的内容针对性,建议在新用户确定后立即提供组信息. ### 跟踪屏幕和事件 事件是您的用户在您的应用程序中接受的“ 动作”, 从点击某个按钮到查看某个特定的屏幕都可以是任何东西 。 一旦安装并初始化了 Appcues Capacitor 插件,您就可以开始使用下列方法跟踪屏幕和事件: ```js // Track event Appcues.track({ name: 'Sent Message' }); // Track event with property Appcues.track({ name: 'Deleted Contact', properties: { id: 123 } }); // Track screen Appcues.screen({ title: 'Contact List' }); // Track screen with property Appcues.screen({ title: 'Contact List', properties: { reference: 'abc' } }); ``` ### 悬疑工具提示 Anchored 工具提示使用元素瞄准来直接指向应用程序中的特定视图. 关于如何配置您应用程序对元素目标视图的更多信息,请参见: [Anchored 工具提示指南](https://github.com/appcues/appcues-capacitor-plugin/blob/main/docs/AnchoredTooltips.md)。 。 。 . ## 页:1 有关这一电容器的更多技术文件载于 [文档](https://github.com/appcues/appcues-capacitor-plugin/tree/main/docs)自动生成的文件 [这里](http://github.com/appcues/appcues-capacitor-plugin/tree/main/docs/ApiDefinition.md)。 。 。 . > 完整的文件可在 [https://docs.appcues.com/ (中文(简体) )](https://docs.appcues.com/) ## 实例 这个 `example` 此寄存器中的目录包含完整的例子 iOS/Android app,用于为正确安装和使用 Appcues API提供参考. ## 捐款 见 [贡献指南](https://github.com/appcues/appcues-capacitor-plugin/blob/main/CONTRIBUTING.md) 学习如何为发展做好准备以及如何为该项目作出贡献. ## 许可证 这个项目根据麻省理工学院的许可证获得许可。 见 [自由主义](https://github.com/appcues/appcues-capacitor-plugin/blob/main/LICENSE) 更多信息. ## 常见问题 ### @appcues/capacitor 是什么？ Capcitor插件在Ionic应用程序中将本地Android和iOS Appcues移动 SDK相接\. ### 如何安装 @appcues/capacitor？ 在项目目录运行 npm install @appcues/capacitor，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（^8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @appcues/capacitor 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @appcues/capacitor 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @appcues/capacitor 可以商用吗？ @appcues/capacitor 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @appcues/capacitor 的下载量有多少？ 根据 npm 官方下载统计，@appcues/capacitor 在 2026/10/07 – 2026/11/05 这 30 天内被下载 32,465 次，日均约 1,082 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @appcues/capacitor 还在维护吗？ 最新版本 5\.0\.7 发布于 2026/10/22（16 天前）；至今共发布 47 个版本，其中过去 12 个月发布了 7 个；首次发布于 2022/09/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。