メインコンテンツへスキップ
@capgo/capacitor-live-reload アップデート オープンソース

Live Reload 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

ガイド

Capacitor で Live Reload を使う方法

@capgo/capacitor-live-reload の使い方

リモートの Vite 開発サーバーから Capacitor アプリを live reload する 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 の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。

よくある質問

Live Reload プラグイン FAQ

Capacitor アプリに Live Reload プラグインをインストールするには?

「bun add @capgo/capacitor-live-reload」(または「npm install @capgo/capacitor-live-reload」)を実行し、次に「bunx cap sync」を実行して、iOS と Android プロジェクトがネイティブ code を認識するようにします。アプリの code から「@capgo/capacitor-live-reload」をインポートしてください。

@capgo/capacitor-live-reload は React、Vue、Angular で動作しますか?

はい。Live Reload は Capacitor パッケージであるため、Ionic、React、Vue、Angular、Svelte、プレーン JavaScript を含む、Capacitor 内で動作するすべての Web フレームワークで動作します。

@capgo/capacitor-live-reload はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-live-reload は無料かつオープンソースですか?

はい。ソース code は https://github.com/Cap-go/capacitor-live-reload/ の GitHub で公開されており、npm から無料でインストールできます。バグレポートやプルリクエストをお待ちしています。

Live Reload を使用している code は、App Store のレビューなしで更新できますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに Live Reload の変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める