Erste Schritte

Installation

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Nutze dann diesen Prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-webview-version-checker` plugin in my project.

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

1. Paket installieren

   bun add @capgo/capacitor-webview-version-checker

2. Native Projekte synchronisieren

   bunx cap sync

3. Optional: Plugin-Konfiguration hinzufügen Du kannst mit den Standardwerten starten (WebviewVersionChecker: {}) oder Prompt- und Schwellwertverhalten anpassen in capacitor.config.ts.

Quickstart

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

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

Beispiel: startMonitoring

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

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

Beispiel: stopMonitoring

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

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

Häufige Stolperfallen

• Listener: Handles beim Unmounten von Screens entfernen.
• Nativer Sync: ausführen bunx cap sync nach Plugin-Upgrades.
• Single Source of Truth: Vertrauen src/definitions.ts im GitHub Repo.

Standardverhalten (Hauptanwendungsfall)

Standardmäßig verwendet dieses Plugin eine Kompatibilitätsregel im Browserslist-Stil:

• minimumDeviceSharePercent ist standardmäßig 3
• der Share-Datensatz wird zur Build-Zeit aus caniuse-Daten gebündelt
• für den Standard-Flow ist kein Runtime-Aufruf einer Datensatz-URL nötig

import type { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    WebviewVersionChecker: {},
  },
};

export default config;

Reine Konfiguration (nativen Prompt anzeigen)

import type { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    WebviewVersionChecker: {
      autoPromptOnOutdated: true,
    },
  },
};

export default config;

Erweiterter Threshold-Modus (Custom Dataset)

import type { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    WebviewVersionChecker: {
      minimumDeviceSharePercent: 3,
      versionShareByMajor: {
        '137': 58.2,
        '136': 21.3,
        '135': 4.6,
        '134': 2.1,
      },
      autoPromptOnOutdated: true,
    },
  },
};

export default config;

Verwenden Sie dies nur, wenn Sie Kompatibilität auf Basis realer Nutzungsanteile statt nur einer festen Version wollen.

• minimumDeviceSharePercent: 3 bedeutet, dass die installierte Major-Version mindestens 3 % Ihres Datensatzes ausmachen muss.
• versionShareByMajor ist deine benutzerdefinierte Map: Major-Version => Prozentsatz.
• Wenn du Remote-Daten bevorzugst, verwende versionShareApiUrl mit einem der folgenden:
  • { "versionShareByMajor": { "137": 54.2, "136": 23.8 } }
  • { "shareByMajor": { "137": 54.2, "136": 23.8 } }
  • { "versions": [{ "major": 137, "share": 54.2 }, { "version": "136.0.0.0", "percent": 23.8 }] }

Erweiterte Nutzung mit JavaScript

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

await WebviewVersionChecker.addListener('webViewOutdated', (status) => {
  console.log('Outdated WebView detected', status);
});

await WebviewVersionChecker.check({
  minimumMajorVersion: 124,
  showPromptOnOutdated: true,
});

Warum dieses Plugin statt nur Capacitor-Konfiguration nutzen

Capacitor unterstützt statische Mindestprüfungen:

android: {
  minWebViewVersion: 124,
},
server: {
  errorPath: 'unsupported-webview.html',
}

Dieses Plugin fügt Runtime-Events und native Prompt-UX hinzu, sodass Nutzer die App weiterhin öffnen und nutzen können, während sie zum Aktualisieren ermutigt werden.

Auswertungsreihenfolge:

1. Geräte-Sharing-Schwellenwert-Modus (minimumDeviceSharePercent + dataset), falls angegeben
2. Neueste Versionsmodus (latestVersion / latestVersionApiUrl)
3. Minimale Major-Fallback (minimumMajorVersion)

Android-Provider-Handling

Das Plugin unterstützt beide WebView-Provider-Modelle, die Capacitor auf Android verwendet:

• Android 5–6 und 10+: Android System WebView (com.google.android.webview)
• Android 7–9: Google Chrome (com.android.chrome)

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte , um natives Media- und Interface-Verhalten zu planen, verbinde es mit @capgo/capacitor-webview-version-checker verwenden für die native Funktion bei der Verwendung von @capgo/capacitor-webview-version-checker, @capgo/capacitor-live-activities verwenden für die native Funktion in „@capgo/capacitor-live-activities verwenden“, @capgo/capacitor-live-activities für die Implementierungsdetails in @capgo/capacitor-live-activities, Verwendung von @capgo/capacitor-video-player für die native Funktion in „@capgo/capacitor-video-player verwenden“, und @capgo/capacitor-video-player für das Implementierungsdetail in @capgo/capacitor-video-player.