Prise en main
Copiez un prompt de configuration incluant les étapes d'installation et le guide markdown complet pour ce plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-inappbrowser`
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/inappbrowser/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.
Installer
Section intitulée « 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 :
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsUtilisez ensuite le prompt suivant :
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-inappbrowser` 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 :
npm install @capgo/capacitor-inappbrowsernpx cap syncImporter
Section intitulée « Import »import { InAppBrowser } from '@capgo/capacitor-inappbrowser';Démarrage rapide : checkout hébergé dans une WebView gérée
Section intitulée « Démarrage rapide : paiement hébergé dans une WebView gérée »import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.openWebView({ url: 'https://billing.example.com/checkout', toolbarType: 'navigation', title: 'Checkout',});
InAppBrowser.addListener('urlChangeEvent', (event) => { if (event.url.includes('/success')) { InAppBrowser.close(); }});Utiliser open() lorsque vous souhaitez utiliser Safari View Controller ou Chrome Custom Tabs sans intégrer une pile WebView native complète.
Choisissez le mode de navigateur
Section intitulée « Choisir le mode navigateur »Utiliser open() lorsque vous souhaitez utiliser le navigateur de la plateforme : Chrome Custom Tabs sur Android et SFSafariViewController sur iOS. Utilisez openWebView() lorsque votre application doit contrôler le WebView natif : taille personnalisée, barre d'outils, messagerie applicative, injection JavaScript, téléchargements, proxy, popups, instances masquées ou superposition d'interfaces.
Cas d'usage courants
Section intitulée « Cas d'utilisation courants »Afficher l’interface Ionic par-dessus une page web live
Section titled “Show Ionic UI Over a Live Browser Page”Ouvrez le WebView géré derrière le WebView hôte Capacitor avec toBack. Votre interface Ionic peut alors s'afficher au-dessus de la page tandis que le contenu web reste chargé en arrière-plan. Transmettez les gestes au navigateur avec dispatchInputEvent() lorsque la superposition doit interagir avec la page.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/checkout', toBack: true, transparentBackground: true,});
await InAppBrowser.dispatchInputEvent({ id, type: 'click', x: 160, y: 420,});
await InAppBrowser.bringToFront({ id });Rendez l’arrière-plan de l’application concernée transparent partout où le navigateur doit être visible. Lorsque le navigateur est derrière l’application, les gestes natifs restent gérés par la WebView Capacitor, sauf si vous les transmettez explicitement.
Créer un navigateur en écran partiel ou un bottom sheet
Section intitulée « Créer un navigateur en écran partiel ou un bottom sheet »Définissez height, width, x, et y pour garder une partie de l'application Capacitor visible autour du navigateur natif. Sur Android et iOS, les événements tactiles en dehors du cadre du navigateur sont transmis à la WebView Capacitor sous-jacente.
const bottomGap = 200;
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/offers', height: window.innerHeight - bottomGap, y: 0,});
await InAppBrowser.updateDimensions({ id, height: window.innerHeight, y: 0,});Utilisez ceci pour des mini-navigateurs, des panneaux d'offres, des widgets de support, des bottom sheets basés sur un navigateur, ou tout flux où les contrôles de l'application native doivent rester cliquables en dehors du contenu web.
Garder les sessions de checkout, d'auth ou de support privées
Section intitulée « Garder les sessions de paiement, d'authentification ou de support privées »Définissez persistWebViewData: false pour les WebViews gérées qui doivent éviter les données de site persistantes lorsque la plateforme le permet. Appelez clearAllBrowsingData() après la déconnexion, le changement de compte, les sessions de test, ou tout flux qui doit vider le store par défaut et les WebViews gérées ouvertes.
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/login', persistWebViewData: false,});
await InAppBrowser.clearAllBrowsingData();await InAppBrowser.close({ id });Sur Android, les cookies utilisent le magasin de cookies du WebView système, donc clearAllBrowsingData() est l’étape de nettoyage des cookies et des autres données partagées du navigateur.
Garder plusieurs instances de navigateur prêtes
Section intitulée « Garder plusieurs instances de navigateur prêtes »Utiliser hidden, hide(), et show() pour précharger ou conserver plusieurs WebViews gérés sans les garder à l’écran. Les WebViews masqués peuvent toujours recevoir executeScript(), postMessage(), setUrl(), et les appels de fermeture.
const first = await InAppBrowser.openWebView({ url: 'https://example.com/a', hidden: true });const second = await InAppBrowser.openWebView({ url: 'https://example.com/b', hidden: true });
await InAppBrowser.show({ id: first.id });await InAppBrowser.hide({ id: first.id });await InAppBrowser.show({ id: second.id });Intégrer des flux avancés d'app web
Section intitulée « Intégrer des flux avancés d’application web »Combinez les règles de proxy, handleDownloads, openBlankTargetInWebView, hiddenPopupWindow, enableGooglePaySupport, postMessage(), et executeScript() pour les portails de documents, les flux d'upload, les pages de paiement, le support et autres web apps intégrées nécessitant un contrôle natif sans quitter votre application.
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/portal', handleDownloads: true, openBlankTargetInWebView: true, hiddenPopupWindow: true, outboundProxyRules: [ { urlRegex: '^https://example\\.com/api/', action: 'delegateToJs', }, ],});
await InAppBrowser.postMessage({ id, detail: { source: 'app', action: 'refresh' },});Aperçu de API
Section intitulée « Aperçu API »Revient en arrière dans l'historique de la WebView si possible
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.goBack();Ouvre l'URL dans une nouvelle fenêtre plein écran ; sur Android, cela passe par Chrome Custom Tabs, sur iOS par SFSafariViewController
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.open({} as OpenOptions);clearCookies
Section intitulée « clearCookies »Effacer les cookies de l’URL
Quand id est omis, s'applique à toutes les webviews ouvertes.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearCookies({} as ClearCookieOptions);clearAllCookies
Section intitulée « clearAllCookies »Effacer tous les cookies
Quand id est omis, s'applique à toutes les webviews ouvertes.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearAllCookies();clearCache
Section intitulée « clearCache »Effacer le cache
Quand id est omis, s'applique à toutes les webviews ouvertes.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearCache();clearAllBrowsingData
Section intitulée « clearAllBrowsingData »Efface toutes les données de navigation du store par défaut et des WebViews gérées ouvertes, y compris les cookies, le cache, le stockage local, le stockage de session, IndexedDB, les données de formulaire et les données d’authentification HTTP lorsque la plateforme les expose.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearAllBrowsingData();getCookies
Section intitulée « getCookies »Récupérer les cookies d'une URL spécifique.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.getCookies({} as GetCookieOptions);Ferme la webview.
Quand id est omis, ferme la webview active.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.close();Masque le webview sans le fermer.
Utilisez show() pour le réafficher.
Quand id est omis, cible la webview active.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.hide();Affiche un webview précédemment masqué.
Quand id est omis, cible la webview active.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.show();sendToBack
Section intitulée « sendToBack »Place le navigateur natif derrière le WebView hôte Capacitor. Utilisez cette méthode lorsque votre interface Ionic doit s’afficher au-dessus d’une page de navigateur active.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.sendToBack({ id: 'webview-id', transparentBackground: true });bringToFront
Section intitulée « bringToFront »Ramène un navigateur situé derrière le WebView hôte au premier plan. Quand id est omis, cible la webview active.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.bringToFront({ id: 'webview-id' });dispatchInputEvent
Section intitulée « dispatchInputEvent »Envoie un événement de clic, tactile ou de défilement à un navigateur géré. Les coordonnées sont relatives au viewport du navigateur, en pixels CSS.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.dispatchInputEvent({ id: 'webview-id', type: 'click', x: 160, y: 420,});openWebView
Section intitulée « openWebView »Ouvrir une URL dans une nouvelle webview avec barres d'outils et fonctionnalités avancées : accès à la caméra, accès aux fichiers, écoute d'événements, injection de JavaScript, communication bidirectionnelle, etc.
Interface JavaScript : Lorsque vous ouvrez une webview avec cette méthode, une interface JavaScript est automatiquement injectée et permet de :
window.mobileApp.close(): Fermer la webview depuis JavaScriptwindow.mobileApp.postMessage({detail: {message: "myMessage"}}): Envoyer un message de la webview vers l'app ; l'objet detail contient les données que vous souhaitez envoyer à la webviewwindow.mobileApp.takeScreenshot()QuandallowScreenshotsFromWebPageest vrai
Les délais des Promises varient selon la plateforme isPresentAfterPageLoad est utilisé.
Android résout avec { id } une fois la boîte de dialogue prête à être contrôlée, tandis qu’iOS résout avec { id } immédiatement après la création du webview natif.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.openWebView({} as OpenWebViewOptions);executeScript
Section intitulée « executeScript »Injecte du JavaScript code dans la fenêtre InAppBrowser.
Lorsque id est omis, s'exécute dans toutes les webviews ouvertes.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.executeScript({} as { code: string; id?: string });postMessage
Section intitulée « postMessage »Envoie un événement au webview (navigateur intégré). Dans le JavaScript du webview, écoutez-l’avec window.addEventListener('messageFromNative', listenerFunc).
detail est la charge utile envoyée au webview. Comme elle traverse le pont Capacitor, elle doit être sérialisable en JSON.
Lorsque id est omis, diffuse vers toutes les webviews ouvertes.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.postMessage({} as { detail: Record<string, any>; id?: string });takeScreenshot
Section intitulée « takeScreenshot »Capture le viewport actuel de la webview en capture d’écran PNG.
Quand id est omis, cible la webview active.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.takeScreenshot();Définit l’URL de la webview.
Quand id est omis, cible la webview active.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setUrl({} as { url: string; id?: string });handleProxyRequest
Section intitulée « handleProxyRequest »Méthode interne utilisée par addProxyHandler() pour renvoyer une décision de proxy au natif.
Transmettez l’original phase lors d'une réponse manuelle proxyRequest listener.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.handleProxyRequest({} as { requestId: string; decision?: ProxyDecision | null; response?: ProxyResponse | null; webviewId?: string; phase?: 'outbound' | 'inbound'; });Recharger la page web actuelle.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.reload();updateDimensions
Section intitulée « updateDimensions »Mettre à jour les dimensions du webview.
Permet de modifier la taille et la position du webview à l’exécution.
Lors id est omis, cible la webview active.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.updateDimensions({} as DimensionOptions & { id?: string });setEnabledSafeTopMargin
Section intitulée « setEnabledSafeTopMargin »Définit l'activation de la marge de sécurité supérieure de la webview à l'exécution.
Lorsque id si omis, cible la webview active.\nSur le Web, cette méthode ne fait rien et se résout sans modifier la mise en page.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setEnabledSafeTopMargin({} as { enabled: boolean; id?: string });setEnabledSafeBottomMargin
Section intitulée « setEnabledSafeBottomMargin »Définit au runtime la marge de sécurité inférieure activée de la webview.
Lorsque id si omis, cible la webview active.\nSur le Web, cette méthode ne fait rien et se résout sans modifier la mise en page.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setEnabledSafeBottomMargin({} as { enabled: boolean; id?: string });openSecureWindow
Section intitulée « openSecureWindow »Ouvre une fenêtre sécurisée pour l'authentification OAuth2. Sur le Web, vous devez avoir le code dans la page de redirection pour utiliser un canal de diffusion et envoyer l'URL de redirection à l'application Comme ceci :
<html><head></head><body><script> const searchParams = new URLSearchParams(location.search) if (searchParams.has("code")) { new BroadcastChannel("my-channel-name").postMessage(location.href); window.close(); }</script></body></html>