安装 Capacitor
你可以创建一个新的 Capacitor 应用程序,也可以将 Capacitor 添加到现有的 Web 项目中。这可以通过 CLI 或使用社区维护的 VS Code 扩展 来完成。
请确保你已经为要构建的平台 设置了环境。
创建新的 Capacitor 应用
可以使用 @capacitor/create-app 包来快速创建一个 Capacitor 应用程序。你可以在空目录中运行以下命令来搭建一个新的 Capacitor 应用程序骨架。
npm init @capacitor/app@latest
将 Capacitor 添加到你的 Web 应用
Capacitor 设计为可以轻松集成到任何现代 JavaScript Web 应用中。但是,要在现有应用中使用 Capacitor,你的项目需要满足以下三个要求:
- 一个
package.json文件 - 一个存放构建后 Web 资源的独立目录,例如
dist或www - 在 Web 资源目录的根目录下有一个
index.html文件
你的 index.html 文件必须包含 <head> 标签,以便 Capacitor 能正确注入。如果你的 HTML 中没有 <head> 标签,Capacitor 插件将无法正常工作。
安装 Capacitor
在你的应用根目录下,安装 Capacitor 的主要 npm 依赖:核心 JavaScript 运行时和命令行界面(CLI)。
npm i @capacitor/core
npm i -D @capacitor/cli
初始化 Capacitor 配置
然后,使用 CLI 问卷初始化 Capacitor:
npx cap init
CLI 会问你几个问题,从你的应用名称和你希望为应用使用的包 ID 开始。它将使用这些配置详细信息创建 capacitor-config 文件,包括你的构建工具构建过程的预期输出目录(例如,Angular 的 www、React 的 build、Vue 的 public 等)。
你可以通过修改 npx cap init 期间创建的 Capacitor 配置 文件中的 webDir 变量来自定义 Capacitor 使用的文件夹。请注意,Capacitor 会尝试通过检查你使用的框架来检测你的 Web 项目的默认值。尽管如此,在首次同步构建遇到问题时,最好还是核对一下这个配置变量。
创建你的 Android 和 iOS 项目
安装 Capacitor 核心运行时后,你可以安装 Android 和 iOS 平台。
npm i @capacitor/android @capacitor/ios
将平台添加到你的 package.json 后,你可以运行以下命令为你的原生应用程序创建 Android 和 iOS 项目。
npx cap add android
npx cap add ios
将你的 Web 代码同步到原生项目
创建原生项目后,你可以通过运行以下命令将你的 Web 应用程序同步到原生项目。
npx cap sync
npx cap sync 会将你在 Capacitor 配置 文件的 webDir 中预期找到的已构建 Web 包复制到你的原生项目中,并安装原生项目的依赖项。
下一步
环境设置妥当,项目结构也正确配置后,你就可以开始了!如果你需要更具体的文档,可以点击下面的任意链接。