Getting Started

Installation

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Copiar al portapapeles

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

Si prefieres la configuración manual, instala el plugin ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación.

1. Instale el paquete

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

2. Sincronizar proyectos nativos

   bunx cap sync

3. Opcional: agregar configuración del plugin Puedes ejecutar con valores por defecto (WebviewVersionChecker: {}o personalizar la configuración de la promoción y el umbral. capacitor.config.ts.

Inicio rápido

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

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

Ejemplo: startMonitoring

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

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

Ejemplo: stopMonitoring

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

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

Problemas comunes

• Escuchadores: eliminar manejadores cuando las pantallas se desmonten.
• Native sync: ejecutar bunx cap sync después de las actualizaciones del plugin.
• Fuente de verdad: confía src/definitions.ts en el repositorio GitHub.

Comportamiento predeterminado (uso principal)

Por defecto, este plugin utiliza una regla de compatibilidad de estilo Browserslist:

• minimumDeviceSharePercent se ajusta a 3
• the share dataset is bundled at build time from caniuse data
• no runtime dataset URL call is needed for the default flow

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

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

export default config;

Configuración simple (mostrar prompt nativo)

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

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

export default config;

Modo de umbral avanzado (conjunto de datos personalizado)

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;

Utiliza esto solo si deseas compatibilidad basada en la participación real del mundo en lugar de solo una versión fija.

• minimumDeviceSharePercent: 3 La versión mayor instalada debe representar al menos el 3% en su conjunto de datos.
• versionShareByMajor es tu mapa personalizado: versión mayor => porcentaje.
• Si prefieres datos remotos, utiliza versionShareApiUrl con uno de:
  • { "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 }] }

Uso avanzado con 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,
});

¿Por qué utilizar este plugin en lugar de solo configurar Capacitor

Capacitor admite verificaciones de mínimo estático:

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

Este plugin agrega eventos de tiempo de ejecución y UX de solicitud nativa, por lo que los usuarios aún pueden abrir y usar la aplicación mientras se les anima a actualizar.

Orden de evaluación:

1. Modo de umbral de dispositivo compartido ("minimumDeviceSharePercent Si se proporciona
2. Modo de versión más reciente (latestVersion / latestVersionApiUrl)
3. Modo de fallback de mayor versión (minimumMajorVersion)

Manejo de proveedores de Android

El plugin admite ambos modelos de proveedores de WebView utilizados por Capacitor en Android:

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

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar el comportamiento de medios nativos e interfaz, conecta con Usando @capgo/capacitor-webview-version-checker para la capacidad nativa en Usando @capgo/capacitor-webview-version-checker, Usando @capgo/capacitor-actividades-en-vivo para la capacidad nativa en Usando @capgo/capacitor-actividades-en-vivo, @capgo/capacitor-actividades-en-vivo para el detalle de implementación en @capgo/capacitor-actividades-en-vivo, Usando @capgo/capacitor-reproductor-de-videos para la capacidad nativa en Usando @capgo/capacitor-reproductor-de-videos, y @capgo/capacitor-reproductor-de-videos para el detalle de implementación en @capgo/capacitor-reproductor-de-videos.