@capgo/capacitor-live-reload
Capacitor plugin to live reload Capacitor apps from a remote Vite dev server.
Overview
Section titled “Overview”Capacitor plugin to live reload Capacitor apps from a remote Vite dev server.
Core Capabilities
Section titled “Core Capabilities”configureServer- Store remote dev server settings used for subsequent connections.connect- Establish a WebSocket connection if one is not already active.disconnect- Close the current WebSocket connection and disable auto reconnect.getStatus- Returns the current connection status.
Public API
Section titled “Public API”| Method | Description |
|---|---|
configureServer | Store remote dev server settings used for subsequent connections. |
connect | Establish a WebSocket connection if one is not already active. |
disconnect | Close the current WebSocket connection and disable auto reconnect. |
getStatus | Returns the current connection status. |
reload | Trigger a full reload of the Capacitor WebView. |
reloadFile | Reload a single file/module if the runtime supports it (falls back to full reload). |
addListener | Listen to incoming reload events emitted by the server. |
addListener | Listen to socket status changes (connected/disconnected). |
removeAllListeners | Remove all registered listeners. |
getPluginVersion | Get the native Capacitor plugin version. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-live-reload.
Keep going from @capgo/capacitor-live-reload
Section titled “Keep going from @capgo/capacitor-live-reload”If you are using @capgo/capacitor-live-reload to plan native plugin work, connect it with Using @capgo/capacitor-live-reload for the native capability in Using @capgo/capacitor-live-reload, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, and Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives.