跳到主要内容
版本:v6

安装 Capacitor

您可以创建一个新的 Capacitor 应用,或将 Capacitor 添加到现有的 Web 项目中。这可以通过 CLI 或使用 VS Code 扩展 完成。

请记得确保您已为目标平台设置好环境

创建新的 Capacitor 应用

@capacitor/create-app 包可用于快速创建 Capacitor 应用。您可以在空目录中运行以下命令来搭建一个新的 Capacitor 应用:

npm init @capacitor/app

将 Capacitor 添加到您的 Web 应用

Capacitor 被设计为可以插入任何现代 JavaScript Web 应用。但是,您的项目需要满足以下三个要求才能将 Capacitor 与现有应用一起使用:

  • 一个 package.json 文件
  • 一个用于构建的 Web 资产的单独目录,例如 distwww
  • 在 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 配置文件,包括您的打包工具的构建过程预期的输出目录(例如,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 包复制到您的原生项目,并安装原生项目的依赖。

下一步

设置好环境并正确配置项目结构后,您就可以开始了!如果您需要更具体的文档,可以点击以下任何链接。

开始使用 iOS ›

开始使用 Android ›

开发者工作流指南 ›