跳到主要内容
版本:v3

构建 Capacitor 插件

Capacitor 提供了一套全面的 Plugin API,用于向 Capacitor 应用添加原生功能。

Capacitor 插件分为两种类型:本地插件是特定于某个 Capacitor 应用的自定义原生代码,存放在作为源代码管理一部分提交的原生项目中。全局插件则是一个已发布的 npm 包,开发者可以将其添加到任何 Capacitor 应用中。

在本教程中,我们将从一个空白的 Capacitor 应用开始,为其添加原生代码来构建一个本地插件。然后我们会将其打包成一个全局插件,准备发布。

那么,我们要构建什么呢?

假设你在一家物流公司工作,你编写的应用让司机能够获取客户的签名,以确认他们已收到货物。法务团队发现,由于司机让客户在竖屏模式下签名,导致客户签名质量不佳。他们要求你在捕获签名时强制应用进入横屏模式。

我们将构建的插件将实现屏幕方向功能来满足这一需求:

  • 检测设备当前的方向,为竖屏和横屏模式提供不同的 UI。
  • 为用户提供选项,以旋转并锁定屏幕方向为横屏模式。
  • 在签名确认后,应用将解锁屏幕方向旋转。

在本教程中,我们将模拟一个签名板,但只构建屏幕方向功能。

这个 ScreenOrientation 插件将适用于 Web、iOS 和 Android 平台。

开始之前

克隆 此仓库 并检出 start 分支。在项目根目录运行 npm install

本教程使用 @ionic/react 来构建用户界面。如果你不熟悉 React 或 Ionic Framework,没关系!所涵盖的概念适用于任何使用支持 TypeScript 的 Web 框架的 Capacitor 应用。

将 iOS 和 Android 平台添加到 Capacitor 应用中:

npm run build
npm install @capacitor/ios @capacitor/android
npx cap add ios
npx cap add android
npx cap sync

现在我们已经有了一个添加了原生平台的 Capacitor 应用,可以继续进行构建插件的第一步:设计 API。