Getting Started
Einen Setup-Befehl mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen Plugin kopieren.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-webview-version-checker`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/webview-version-checker/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
-
Das Paket installieren
Terminal-Fenster bun add @capgo/capacitor-webview-version-checker -
Natives Projekte synchronisieren
Terminal-Fenster bunx cap sync -
Optional: Hinzufügen von Plugin-Konfiguration Sie können mit den Standards (
WebviewVersionChecker: {}) laufen oder die Anzeige und die Schwellenwertverhalten anpassencapacitor.config.ts.
Standardverhalten (Hauptnutzungsfall)
Abschnitt mit dem Titel “Standardverhalten (Hauptnutzungsfall)”Standardmäßig verwendet dieses Plugin eine Browserslist-Style-Kompatibilitätsregel:
minimumDeviceSharePercentstandardmäßig3- die Teildatenmenge wird bei der Buildzeit aus caniuse-Daten gebündelt
- keine runtime-Datenmenge-URL-Aufruf ist für den Standardfluss erforderlich
import type { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = { plugins: { WebviewVersionChecker: {}, },};
export default config;Einfache Konfiguration nur (Zeige native Anzeige)
Abschnitt mit dem Titel „Einfache Konfiguration nur (Zeige natives Fenster)“import type { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = { plugins: { WebviewVersionChecker: { autoPromptOnOutdated: true, }, },};
export default config;Erweiterte Schwellenwert-Modus (Benutzerdefinierte Datensatz)
Abschnitt mit dem Titel „Erweiterte Schwellenwert-Modus (Benutzerdefinierte Datensatz)“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 der Grundlage der tatsächlichen Verwendung und nicht nur auf einer festen Version möchten.
minimumDeviceSharePercent: 3bedeutet, dass die installierte Hauptversion mindestens 3 % in Ihrem Datensatz darstellen muss.versionShareByMajorIst Ihr benutzerdefinierter Karten: Hauptversion => Prozent.- Wenn Sie remote Daten bevorzugen, verwenden Sie
versionShareApiUrlmit einem von:{ "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 Verwendung mit JavaScript
Abschnitt mit dem Titel „Erweiterte Verwendung 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 sollte man dieses Plugin statt nur Capacitor-Konfiguration verwenden
Abschnitt mit dem Titel “Warum sollte man dieses Plugin statt nur Capacitor-Konfiguration verwenden”Capacitor unterstützt statische Mindestprüfungen:
android: { minWebViewVersion: 124,},server: { errorPath: 'unsupported-webview.html',}Dieses Plugin fügt Echtzeitereignisse und native Benutzeroberfläche für Anfragen hinzu, sodass Benutzer das App-Update trotzdem öffnen und verwenden können.
Bewertungsreihenfolge:
- Geräteteilungs-Schwelle-Modus (
minimumDeviceSharePercent+Datenmenge), falls bereitgestellt - Neueste Version-Modus (
latestVersion/latestVersionApiUrl) - Mindestmajor-Fallback (
minimumMajorVersion)
Android-Anbieter-Handling
Abschnitt mit dem Titel “Android-Anbieter-Verwaltung”The plugin supports both WebView provider models used by Capacitor on Android:
- Android 5-6 und 10+: Android System WebView (
com.google.android.webview) - Android 7-9: Google Chrome (
com.android.chrome)
Weitergehen von Getting Started
Abschnitt mit dem Titel “Weitergehen von Getting Started”Wenn Sie native Medien und Schnittstellenverhalten planen und es mit Getting Started verbinden möchten, verwenden Sie Using @capgo/capacitor-webview-version-checker for the native capability in Using @capgo/capacitor-webview-version-checker, Using @capgo/capacitor-live-activities für die native Fähigkeit in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities für die Implementierungsdetail in @capgo/capacitor-live-activities, Using @capgo/capacitor-video-player für die native Fähigkeit in Using @capgo/capacitor-video-player und @capgo/capacitor-video-player für die Implementierungsdetail in @capgo/capacitor-video-player.