跳到主要内容
版本：v5

打包插件

ScreenOrientation 插件功能完整，并已作为本地插件集成到 Capacitor 应用中。但是，ScreenOrientation 插件在目前状态下不能被其他 Capacitor 应用使用。

让我们继续打包插件以便发布，使 ScreenOrientation 插件全局可用。

注意： 本节引用了 Capacitor 文档的创建 Capacitor 插件部分中的步骤和流程。超出本教程范围之外的详细信息，请参阅文档。

生成新的插件项目​

Capacitor 有一个插件生成器，我们可以用它来搭建一个适合发布全局插件的项目格式。

在一个新的终端中，运行以下命令：

npx @capacitor/create-plugin \
  --name @capacitor-community/screen-orientation \
  --package-id io.ionic.plugins.screenorientation \
  --class-name ScreenOrientation \
  --repo "https://ionic.io" \
  --license "MIT" \
  --description "以统一方式处理 iOS、Android 和 Web 的屏幕方向"

当提示提供目录时，按 Enter 使用默认值。当询问作者姓名时，请使用您自己的！

移植插件代码​

查看生成的项目结构；它与为 Capacitor 应用构建的结构非常相似，不是吗？🤔

显然，这是有意为之，以便轻松地将插件代码从 Capacitor 应用的代码库移植到生成的插件项目中。

将 src/plugins/screen-orientation 中文件的内容复制到插件项目中对应的 web.ts、index.ts 和 definitions.ts 文件中。

接下来，将一个代码库中的 ScreenOrientation.swift、ScreenOrientationPlugin.m 和 ScreenOrientationPlugin.swift 的内容复制到另一个。

然后，对 ScreenOrientation.java 和 ScreenOrientationPlugin.java 执行相同操作。之后，更新插件项目中这些文件的包名：

package io.ionic.plugins.screenorientation

上面的包名是在生成插件项目时提供的，项目中的任何 Android 文件都应使用此包名。

最后，通过运行以下命令来验证移植代码时没有出现问题：

npm run verify

注意： 您可以通过将插件文件夹链接到 Capacitor 项目来在发布前测试插件。有关详细信息，请参阅插件开发工作流。

更新插件文档​

查看插件项目的 README.md 文件；它已更新以记录插件的 API。这种更新发生在我们运行 npm run verify 时。对源文件 JSDoc 注释所做的任何更改都可以通过运行 npm run docgen 反映到 readme 文件的 API 部分中。

该插件要求开发者修改其 Capacitor 应用的 AppDelegate.swift 文件，因此应在插件文档中包含相关操作说明。

注意： 始终记录您在安装或配置您构建的插件时，开发者需要进行的任何修改。

将 README.md 中的"Install"部分替换为以下 markdown：

安装​

npm install @capacitor-community/screen-orientation
npx cap sync

iOS​

对于 iOS，您必须对 AppDelegate.swift 文件进行以下调整：

import UIKit
+ import CapacitorCommunityScreenOrientation

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
+   func application(_ application: UIApplication, supportedInterfaceOrientationsFor window: UIWindow?) -\> UIInterfaceOrientationMask {
+     return ScreenOrientationPlugin.supportedOrientations
+  }
}

发布插件​

插件现在可以发布到 npm 仓库了。在本教程中我们不会这样做，但请注意，发布 Capacitor 插件项目的命令与发布任何其他 npm 包相同：npm publish。

您可以将全局 Capacitor 插件发布到公共 npm 仓库、私有仓库，或者仅将其链接到本地机器上的一堆项目。任何适合您使用场景的方式都可以。

此外，还有一个 Capacitor Community GitHub 组织，您可以在其中托管您的插件，并在继续开发和维护您的插件时与社区和 Capacitor 团队密切合作。

结论​

Capacitor 的插件 API 是一个灵活且健壮的解决方案，用于为 Capacitor 应用补充 Web 不可用的原生功能，无论是为特定应用添加自定义原生代码，还是在一组应用之间重用原生代码。

期待您接下来开发的插件！🎉

Contents

编辑此页