跳过主要内容

实时重载 Capacitor插件

连接到您的开发服务器以实现开发期间即时热重载

安装

bun add @capgo/capacitor-live-reload bunx cap sync
npm、pnpm或yarn
  • npm install @capgo/capacitor-live-reload
  • pnpm add @capgo/capacitor-live-reload
  • yarn add @capgo/capacitor-live-reload

指南

How to use Capacitor in Capacitor

使用 @capgo/capacitor-live-reload

Capacitor 插件用于从远程 Vite 开发服务器实时重载 Capacitor 应用

安装

bun add @capgo/capacitor-live-reload
bunx cap sync

bunx cap sync 将插件的本机 code 复制到本机项目中。每次升级插件后都重新运行它

导入

import { LiveReload } from '@capgo/capacitor-live-reload';

API 简介

方法 描述
configureServer 存储用于后续连接的远程开发服务器设置
connect 建立一个 WebSocket 连接,如果没有正在活动的连接
disconnect 关闭当前 WebSocket 连接并禁用自动重连
getStatus 当前连接状态。
reload 触发 Capacitor WebView 的全局重载。
reloadFile 当运行时支持时,重新加载单个文件/模块(如果不支持则进行全局重新加载)。

示例

configureServer()

用于后续连接的远程开发服务器设置。

import { LiveReload } from '@capgo/capacitor-live-reload';

const result = await LiveReload.configureServer({ url: 'https://example.com' });
console.log(result);

connect()

建立 WebSocket 连接 (如果尚未激活)

import { LiveReload } from '@capgo/capacitor-live-reload';

const result = await LiveReload.connect();
console.log(result);

disconnect()

关闭当前 WebSocket 连接并禁用自动重连

import { LiveReload } from '@capgo/capacitor-live-reload';

const result = await LiveReload.disconnect();
console.log(result);

getStatus()

当前连接状态。

import { LiveReload } from '@capgo/capacitor-live-reload';

const result = await LiveReload.getStatus();
console.log(result);

reload()

触发 Capacitor WebView 的全局重载。

import { LiveReload } from '@capgo/capacitor-live-reload';

await LiveReload.reload();

reloadFile()

当运行时支持时,重新加载单个文件/模块(如果不支持则进行全局重新加载)。

import { LiveReload } from '@capgo/capacitor-live-reload';

await LiveReload.reloadFile({ path: 'path/to/file' });

监听事件

addListener 返回句柄,调用 handle.remove() 当屏幕卸载时,或者 LiveReload.removeAllListeners() 清除所有监听器。

完整参考

继续使用@capgo/capacitor-live-reload

继续使用 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-live-reload 使用@capgo/capacitor-live-reload 使用 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-live-reload @capgo/capacitor-live-reload @capgo/capacitor-live-reload 开始使用 为开始使用的实现细节 Capgo 插件目录 为Capgo 插件目录中的产品工作流程 Capacitor 由 Capgo 提供的插件 为Capacitor 由 Capgo 提供的插件的实现细节 添加或更新插件 为添加或更新插件的实现细节

常见问题

Live Reload插件常见问题

如何在Capacitor应用中安装Live Reload插件?

运行"bun add @capgo/capacitor-live-reload"(或"npm install @capgo/capacitor-live-reload"),然后运行"bunx cap sync",使iOS和Android项目捕获到native code。从"@capgo/capacitor-live-reload"中导入它,然后在应用code中使用。

@capgo/capacitor-live-reload与React、Vue和Angular兼容吗?

是的。Live Reload是一个Capacitor包,因此它与任何运行在Capacitor中的Web框架兼容,包括Ionic、React、Vue、Angular、Svelte和普通JavaScript。

哪个 Capacitor 版本支持 @capgo/capacitor-live-reload?

Capgo 插件遵循 Capacitor 的主要版本:使用与 Capacitor 主要版本匹配的插件主要版本(例如插件 v8 与 Capacitor 8)。在 GitHub README 中的兼容性表格中列出了维护的版本。

是否支持 @capgo/capacitor-live-reload 免费和开源?

是。源码 code 公开在 GitHub 上(https://github.com/Cap-go/capacitor-live-reload/)并且可以从 npm 免费安装。欢迎bug报告和pull请求。

是否可以在不经过 App Store 审核的情况下更新使用 Live Reload 的 code?

安装或升级插件会改变本机 code,因此需要新建一个商店构建。之后,通过 Capgo 实时更新的 JavaScript、HTML 和 CSS 变更可以立即部署给用户。

不必等待应用程序审查即可将Live Reload更改交付

一旦插件在您的商店构建中,Capgo实时更新将将JavaScript、HTML和CSS更改推送给用户,仅需几分钟

从Capgo开始