构建 Capacitor 插件
Capacitor 提供了一套全面的插件 API,用于为 Capacitor 应用添加原生功能。
Capacitor 插件主要有两种类型:本地插件是专属于特定 Capacitor 应用的定制原生代码,存放在作为源代码管理一部分的原生项目中。全局插件则是已发布的 npm 包,开发者可以将其添加到任何 Capacitor 应用中。
在本教程中,我们将从一个空白的 Capacitor 应用开始,逐步添加原生代码来构建一个本地插件。然后我们会将其打包成全局插件,准备发布。
那么,我们要构建什么?
假设你在一家快递公司工作,你编写的应用让司机能够获取客户签名以确认收货。法务团队发现客户签名质量不佳,因为司机让客户在竖屏模式下签名。他们要求你在捕获签名时强制应用切换到横屏模式。
我们将构建的插件将实现屏幕方向功能来满足这一需求:
- 检测设备当前方向,为竖屏和横屏模式提供不同的用户界面。
- 为用户提供锁定屏幕方向为横屏模式的选项。
- 确认签名后,应用将解锁屏幕方向旋转。
在本教程中,我们将模拟一个签名板,但仅构建屏幕方向功能。
这个 ScreenOrientation 插件将支持 Web、iOS 和 Android 平台。
开始之前
克隆此仓库并检出 start 分支。在项目根目录运行 npm install。
本教程使用
@ionic/react构建用户界面。如果您不熟悉 React 或 Ionic Framework,没关系!所涵盖的概念适用于使用任何支持 TypeScript 的 Web 框架的 Capacitor 应用。
为 Capacitor 应用添加 iOS 和 Android 平台:
npm run build
npm install @capacitor/ios @capacitor/android
npx cap add ios
npx cap add android
npx cap sync
现在我们已经搭建好包含原生平台的 Capacitor 应用,可以继续构建插件的第一步:设计 API。