Skip to main content
Back to plugins
@capgo/capacitor-webview-guardian
Tutorial
@capgo/capacitor-webview-guardian

WebView Guardian

Detect when the WebView was killed in the background and relaunch it on foreground

Guide

Tutorial on WebView Guardian

Test on device

Download the Capgo app, then scan the QR code.

WebView Guardian plugin preview QR code

Using @capgo/capacitor-webview-guardian

Capacitor plugin to Detect when the WebView was killed in the background and relaunch it on foreground.

Install

bun add @capgo/capacitor-webview-guardian
bunx cap sync

What This Plugin Exposes

  • startMonitoring - Starts observing foreground events and automatically checks the WebView health.
  • stopMonitoring - Stops any automatic foreground monitoring.
  • getState - Returns the latest known monitoring state.
  • checkNow - Forces a WebView health probe immediately.

Example Usage

startMonitoring

Starts observing foreground events and automatically checks the WebView health.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

await WebviewGuardian.startMonitoring();

stopMonitoring

Stops any automatic foreground monitoring.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

await WebviewGuardian.stopMonitoring();

getState

Returns the latest known monitoring state.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

await WebviewGuardian.getState();

checkNow

Forces a WebView health probe immediately.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

await WebviewGuardian.checkNow();

Full Reference

Keep going from Using @capgo/capacitor-webview-guardian

If you are using Using @capgo/capacitor-webview-guardian to plan native media and interface behavior, connect it with @capgo/capacitor-webview-guardian for the implementation detail in @capgo/capacitor-webview-guardian, Getting Started for the implementation detail in Getting Started, Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, and Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player.