WebView Version Checker Capacitor plugin

Using @capgo/capacitor-webview-version-checker

Public API for checking WebView freshness and guiding users to updates.

Install

bun add @capgo/capacitor-webview-version-checker
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { WebviewVersionChecker } from '@capgo/capacitor-webview-version-checker';

API at a glance

Examples

check()

Runs a version check and returns the latest known status.

import { WebviewVersionChecker } from '@capgo/capacitor-webview-version-checker';

const result = await WebviewVersionChecker.check();
console.log(result);

startMonitoring()

Enables background monitoring (typically on app resume).

import { WebviewVersionChecker } from '@capgo/capacitor-webview-version-checker';

const result = await WebviewVersionChecker.startMonitoring();
console.log(result);

stopMonitoring()

Disables monitoring.

import { WebviewVersionChecker } from '@capgo/capacitor-webview-version-checker';

const result = await WebviewVersionChecker.stopMonitoring();
console.log(result);

getLastStatus()

Returns the last resolved status, or null if no check was run yet.

import { WebviewVersionChecker } from '@capgo/capacitor-webview-version-checker';

const result = await WebviewVersionChecker.getLastStatus();
console.log(result);

showUpdatePrompt()

Shows a native prompt asking the user to update the WebView.

import { WebviewVersionChecker } from '@capgo/capacitor-webview-version-checker';

const result = await WebviewVersionChecker.showUpdatePrompt();
console.log(result);

openUpdatePage()

Opens the configured update page directly.

import { WebviewVersionChecker } from '@capgo/capacitor-webview-version-checker';

const result = await WebviewVersionChecker.openUpdatePage();
console.log(result);

Listen to events

addListener returns a handle. Call handle.remove() when the screen unmounts.

Full reference

• GitHub repository
• Documentation
• API reference

Keep going from Using @capgo/capacitor-webview-version-checker

If you are using Using @capgo/capacitor-webview-version-checker to plan native media and interface behavior, connect it with @capgo/capacitor-webview-version-checker for the implementation detail in @capgo/capacitor-webview-version-checker, 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.