选择接入包
先看项目的构建工具和框架,再决定安装入口。常规业务项目只直接依赖 构建插件 + 对应框架绑定;内部运行时和 Workbox 引擎由包管理器作为传递依赖安装。
构建环境需要 Node.js 22.12 或更高版本;以下框架范围与已发布包的 peer 依赖一致。
| 项目 | 直接安装 | 公开状态 |
|---|---|---|
| Vite 8 + Vue >=3.4、<4 | @pwa-platform/vite、@pwa-platform/vue | npm beta |
| Vite 8 + React >=19.2、<20 | @pwa-platform/vite、@pwa-platform/react | npm beta |
| Nuxt 4.5.x | @pwa-platform/nuxt | 工作区私有,尚未公开 |
| TanStack Start / Next.js | 暂无可用的公开适配包 | 不在当前接入范围 |
如果 TypeScript 配置文件需要直接标注 PwaIdentity、PwaInstallMetadata 和 PwaPolicy 类型,可额外将 @pwa-platform/contracts 安装为开发依赖。不要从它导入运行时行为,也不要直接引入 core、sw-runtime、client-runtime 或 engine-workbox。
安装命令
Vue:
bash
pnpm add @pwa-platform/vue@0.1.0-beta.1
pnpm add -D @pwa-platform/vite@0.1.0-beta.1 @pwa-platform/contracts@0.1.0-beta.1React:
bash
pnpm add @pwa-platform/react@0.1.0-beta.1
pnpm add -D @pwa-platform/vite@0.1.0-beta.1 @pwa-platform/contracts@0.1.0-beta.1安装命令写明版本号,因为当前 npm 的 latest 标签也指向 beta,不应由标签推断稳定性。
接入顺序
- 按实际部署地址写身份、安装信息与策略。
- 在 Vite 配置中挂载插件。
- 在页面入口放入框架绑定并主动调用
register()。 - 构建后部署到 HTTPS 站点,按上线前检查验证。