ガイド
Capacitor で Live Reload を使う方法
@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/capacitor-live-reload を使用する ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-live-reload @capgo/capacitor-live-reload の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。