Panduan Memulai

Instalasi

Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:

1. Instal package

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

2. Sinkronkan proyek native

   bunx cap sync

3. Opsional: tambah konfigurasi plugin Anda bisa menjalankan dengan default (WebviewVersionChecker: {}) atau sesuaikan perilaku prompt dan threshold di capacitor.config.ts.

Mulai cepat

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

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

Contoh: startMonitoring

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

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

Contoh: stopMonitoring

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

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

Kesalahan umum

• Listener: hapus handle saat screen unmount.
• Sinkronisasi Native: jalankan bunx cap sync setelah upgrade plugin.
• Sumber kebenaran tunggal: percayai src/definitions.ts di repo GitHub.

Perilaku default (kasus penggunaan utama)

Secara default, plugin ini memakai aturan kompatibilitas ala Browserslist:

• minimumDeviceSharePercent defaultnya adalah 3
• dataset share dibundel saat build time dari data caniuse
• tidak perlu pemanggilan URL dataset saat runtime untuk alur default

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

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

export default config;

Setup simpel hanya via config (tampilkan native prompt)

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

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

export default config;

Mode threshold lanjutan (dataset kustom)

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;

Gunakan ini hanya jika Anda ingin kompatibilitas berdasarkan share dunia nyata, bukan sekadar versi tetap.

• minimumDeviceSharePercent: 3 berarti major version yang terinstal harus mewakili setidaknya 3% dalam dataset Anda.
• versionShareByMajor adalah custom map Anda: major version => persentase.
• Jika Anda lebih suka data remote, gunakan versionShareApiUrl dengan salah satu dari:
  • { "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 }] }

Penggunaan lanjutan dengan 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,
});

Mengapa pakai plugin ini dibanding hanya config Capacitor

Capacitor mendukung pengecekan minimum statis:

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

Plugin ini menambahkan event runtime dan UX prompt native, sehingga user tetap bisa membuka dan memakai aplikasi sambil didorong untuk update.

Urutan evaluasi:

1. Mode ambang batas device-share (minimumDeviceSharePercent + dataset), jika tersedia
2. Mode versi terbaru ("latestVersion / latestVersionApiUrl)
3. Fallback major minimum ("minimumMajorVersion)

Penanganan provider Android

Plugin ini mendukung kedua model provider WebView yang digunakan Capacitor di Android:

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

Lanjutkan dari Getting Started

Jika Anda menggunakan Panduan Memulai untuk merencanakan perilaku media dan antarmuka native, hubungkan dengan Menggunakan @capgo/capacitor-webview-version-checker untuk kapabilitas native di Menggunakan @capgo/capacitor-webview-version-checker, Menggunakan @capgo/capacitor-live-activities untuk kemampuan native di Menggunakan @capgo/capacitor-live-activities, @capgo/capacitor-live-activities untuk detail implementasi di @capgo/capacitor-live-activities, Menggunakan @capgo/capacitor-video-player untuk kemampuan native di Menggunakan @capgo/capacitor-video-player, dan @capgo/capacitor-video-player untuk detail implementasi di @capgo/capacitor-video-player.