@capgo/capacitor-inappbrowser

Présentation

@capgo/capacitor-inappbrowser fournit aux applications Capacitor deux chemins d'accès du navigateur : open() pour l'expérience du navigateur système et openWebView() pour un WebView natif géré que votre application peut dimensionner, masquer, envoyer des messages, scripter, faire passer les requêtes et surposer avec l'interface d'Ionic.

Utilisez-le lorsque la page nécessite plus qu'un simple navigateur externe : les flux OAuth et de paiement, les portails d'assistance intégrés, les écrans de paiement, les appels vidéo, les portails de documents, les applications web interactives ou tout flux où votre application nécessite des contrôles natifs autour du contenu web en direct.

Le nom du package a changé.

Utilisations courantes

• Présentez l'interface d'Ionic ou Capacitor au-dessus d'une page de navigateur en direct avec toBack, sendToBack(), bringToFront(), transparentBackground, et dispatchInputEvent().
• Construisez des navigateurs à écran partiel, des feuilles de bas et des webviews en image sur image avec width, height, x, yet updateDimensions().
• Permettez aux utilisateurs de cliquer sur l'application Capacitor en dehors d'une fenêtre de navigateur personnalisée de taille fixe sur Android et iOS.
• Exécutez les flux de paiement, de connexion, de support ou de basculement de compte sans stockage de site web persistant en utilisant persistWebViewData: false et clearAllBrowsingData().
• Maintenez plusieurs instances de navigateur chargées avec hidden, hide(), et show() en conservant l'état de la page.
• Intégrez des applications web avancées nécessitant la mise en cache de requêtes, les téléchargements de fichiers, les téléchargements, le contrôle des pop-up, le support de Google Pay, _blank la gestion des liens et la messagerie application-page.

Capacités de base

• open - Ouvre une URL dans Chrome Custom Tabs sur Android ou iOS SFSafariViewController On iOS.
• openWebView - Ouvre une vue native gérée avec une barre d'outils personnalisée, une taille, une navigation native, des messages, des scripts, un proxy, des téléchargements, des pop-ups et des contrôles de données.
• sendToBack / bringToFront - Déplace une fenêtre de navigateur gérée derrière ou au-dessus de la vue Capacitor hôte.
• dispatchInputEvent - Envoie les événements de clic, de toucher et de scroll vers une fenêtre de navigateur qui se trouve derrière l'interface utilisateur de l'application native.
• updateDimensions - Modifie la taille et la position de la vue WebView gérée sans recharger la page.
• hide / show - Garde les vues Web gérées chargées tout en supprimant ou en restaurant leur présentation native.
• postMessage / executeScript - Connecte l'application Capacitor avec le JavaScript exécuté à l'intérieur de la page gérée.
• clearAllBrowsingData / persistWebViewData - Contrôle la persistance des cookies, de la cache, du stockage, de l'IndexedDB et de la session.
• handleDownloads, les règles de proxy et les événements de pop-up - Supporte les portails de documents, les flux de téléchargement, les pages de paiement et les applications web intégrées.

Public API

Méthode	Description
goBack	Retourne en arrière dans l'historique de la vue Web si possible.
open	Ouvre l'URL dans une nouvelle fenêtre en plein écran, sur Android, elle utilise les onglets personnalisés de Chrome, sur iOS, elle utilise SFSafariViewController.
clearCookies	Efface les cookies de l'URL Lorsque id s'il est omis, s'applique à toutes les vues Web ouvertes.
clearAllCookies	Efface tous les cookies Lorsque id s'il est omis, s'applique à toutes les vues Web ouvertes.
clearCache	Efface le cache Lorsque id s'il est omis, s'applique à toutes les vues Web ouvertes.
clearAllBrowsingData	Efface les cookies, le cache, le stockage local, le stockage de session, IndexedDB et autres données de navigation du magasin par défaut et des vues Web gérées.
getCookies	Obtenez les cookies pour une URL spécifique.
close	Fermer la vue Web. Lorsque id est omis, ferme la vue web active.
hide	Cache la vue web sans la fermer. Utilisez show() pour la faire réapparaître. Lorsque id est omis, cible la vue web active.
show	Montre une vue web précédemment cachée. Lorsque id est omis, cible la vue web active.
sendToBack	Déplace le navigateur natif derrière la Capacitor vue WebView pour que l'interface utilisateur de l'application apparaisse au-dessus.
bringToFront	Déplace un navigateur qui se trouvait derrière la vue WebView vers l'avant.
dispatchInputEvent	Envoie un clic, un toucher ou un défilement d'entrée vers un navigateur géré ; les coordonnées sont relatives à la vue de navigateur.
openWebView	Ouvre l'URL dans une nouvelle vue web avec des barres d'outils et des capacités améliorées, comme l'accès à la caméra, l'accès aux fichiers, l'écoute des événements, l'injection de JavaScript, la communication bidirectionnelle, etc.
executeScript	Injecte le JavaScript code dans la fenêtre InAppBrowser. Lorsque id est omis, exécute dans toutes les vues web ouvertes.
postMessage	Envoie un événement à la vue web (navigateur intégré). Écoutez dans la page avec window.addEventListener('messageFromNative', listenerFunc)Le payload doit être sérialisable en JSON. Lorsque detail Lorsque est omis, les diffusions sont envoyées à tous les webviews ouverts. id Captures l'actuel viewport du webview sous forme d'écran PNG. Lorsque est omis, cible le webview actif.
takeScreenshot	Définit l'URL du webview. Lorsque est omis, cible le webview actif. id Écoutez les changements d'URL, uniquement pour openWebView.
setUrl	Écoutez id ; le payload contient le webview
addListener	Écoutez uniquement le clic de fermeture pour openWebView.
addListener	Seront déclenchés lorsque l'utilisateur clique sur le bouton de confirmation lorsque la déclaration est requise, fonctionne avec openWebView shareDisclaimer et closeModal. buttonNearDoneClick__CAPGO_KEEP_0__ id.
addListener	__CAPGO_KEEP_0__
addListener	__CAPGO_KEEP_0__
addListener	Se déclenche lorsque la vue web envoie un événement vers l'application. Utilisez window.mobileApp.postMessage(...) dans la page, et gardez le payload JSON-serialisable.
addListener	Se déclenchera chaque fois qu'un écran d'écran est capturé à partir du plugin API, le bouton d'écran natif ou le pont JavaScript injecté.
addListener	Se déclenchera chaque fois que la page est chargée.
addListener	Se déclenchera chaque fois qu'une erreur de chargement de page se produit.
addListener	Se déclenchera après que le traitement de téléchargement natif a enregistré un fichier localement. Activez cela avec handleDownloads: true lorsque vous ouvrez la vue web.
addListener	Se déclenchera chaque fois que le traitement de téléchargement natif échoue. Activez cela avec handleDownloads: true lorsque vous ouvrez la vue web.
addListener	Se déclenchera chaque fois qu'une page ouvre une nouvelle fenêtre. Utilisez l'ID de la fenêtre popup retourné avec executeScript, postMessage, show, hide, et close.
addListener	Écoutez les requêtes déléguées par le runtime natif. Préférez addProxyHandler() au lieu d'appeler cela directement.
addListener	Écoutez les sorties de console JavaScript émises par la page gérée. Activez cela avec captureConsoleLogs: true lors de l'ouverture de la vue web.
handleProxyRequest	Méthode interne utilisée par addProxyHandler() pour envoyer une décision de proxy vers le natif. Transmettez l'original phase lors de la réponse à un appel manuel proxyRequest écouteur.
removeAllListeners	Supprimez tous les écouteurs pour ce plugin.
reload	Rechargez la page web actuelle.
updateDimensions	Met à jour les dimensions de la vue web. Permet de modifier la taille et la position de la vue web en temps de exécution. Lorsque id est omis, cible la vue web active.
setEnabledSafeTopMargin	Définit la marge de sécurité supérieure autorisée de la vue web en temps de exécution. Lorsque id est omis, cible le webview actif. Sur le Web, cette méthode est une opération sans effet et se résout sans modifier la disposition.
setEnabledSafeBottomMargin	Définit la marge inférieure sécurisée active du webview en temps de exécution. Lorsque id est omis, cible le webview actif. Sur le Web, cette méthode est une opération sans effet et se résout sans modifier la disposition.
openSecureWindow	Ouvre une fenêtre OAuth2 sécurisée. Sur le Web, retourne l'URL redirigée à travers un BroadcastChannel; sur les appareils mobiles, enregistrez une URI de redirection personnalisée dans la configuration de votre application. Consultez le guide de démarrage rapide pour les exemples complets d'HTML, Info.plist et AndroidManifest.

Source De Vérité

Cette référence est synchronisée à partir de src/definitions.ts dans capacitor-inappbrowser.

Continuez de là à @capgo/capacitor-inappbrowser

Si vous utilisez @capgo/capacitor-inappbrowser pour planifier le travail de plugin natif, connectez-le à En utilisant @capgo/capacitor-inappbrowser pour la capacité native dans En utilisant @capgo/capacitor-inappbrowser, Répertoire de plugin Capgo pour le flux de travail du produit dans Répertoire de plugin Capgo, Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou Mettre à jour les plugins pour le détail d'implémentation dans Ajouter ou Mettre à jour les plugins, et Alternatives de plugins d'entreprise Ionic Enterprise pour le flux de produit dans les alternatives du plugin Enterprise Ionic.