Prise en main

Installation

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

1. Installer le package

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

2. Synchroniser les projets natifs

   bunx cap sync

3. Facultatif : ajouter la config du plugin Vous pouvez exécuter avec les valeurs par défaut (WebviewVersionChecker: {}) ou personnalisez le comportement du prompt et du seuil dans capacitor.config.ts.

Démarrage rapide

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

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

Exemple : startMonitoring

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

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

Exemple : stopMonitoring

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

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

Erreurs courantes

• Écouteurs: supprimez les handles lors du démontage des écrans.
• Sync native : exécuter bunx cap sync après les mises à jour du plugin.
• Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Comportement par défaut (cas d’usage principal)

Par défaut, ce plugin utilise une règle de compatibilité de type Browserslist :

• minimumDeviceSharePercent par défaut sur 3
• le jeu de données de partage est inclus au moment du build à partir des données caniuse
• Aucun appel d’URL de dataset au runtime n’est nécessaire pour le flux par défaut

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

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

export default config;

Configuration seule (afficher le prompt natif)

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

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

export default config;

Mode seuil avancé (jeu de données personnalisé)

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;

Utilisez ceci uniquement si vous souhaitez une compatibilité basée sur la part réelle d’utilisation plutôt que sur une version fixe.

• minimumDeviceSharePercent: 3 signifie que la version majeure installée doit représenter au moins 3 % de votre jeu de données.
• versionShareByMajor est votre mapping personnalisé : version majeure => pourcentage.
• Si vous préférez les données distantes, utilisez versionShareApiUrl avec l'un de ces choix :
  • { "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 }] }

Usage avancé avec 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,
});

Pourquoi utiliser ce plugin plutôt qu'une simple config Capacitor

Capacitor supports static minimum checks:

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

Ce plugin ajoute des événements runtime et une UX de prompt native, pour que les utilisateurs puissent ouvrir et utiliser l'app tout en étant incités à mettre à jour.

Ordre d'évaluation :

1. Mode seuil de partage d'appareils (minimumDeviceSharePercent + dataset), si fourni
2. Mode dernière version (latestVersion / latestVersionApiUrl)
3. Repli sur la version majeure minimale (minimumMajorVersion)

Gestion du provider Android

Le plugin prend en charge les deux modèles de fournisseur WebView utilisés par Capacitor sur Android :

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

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier le comportement des médias et de l'interface natifs, connectez-l’à Utiliser @capgo/capacitor-webview-version-checker pour la capacité native dans Utiliser @capgo/capacitor-webview-version-checker Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities Utiliser @capgo/capacitor-video-player pour la capacité native dans Utiliser @capgo/capacitor-video-player, et @capgo/capacitor-video-player pour le détail d'implémentation dans @capgo/capacitor-video-player.