@capgo/capacitor-InAppBrowser

Übersicht

@capgo/capacitor-inappbrowser bietet Capacitor-Apps zwei Browser-Pfade: open() für die Erfahrung des Systembrowsers und openWebView() für einen verwalteten nativen WebView, den Ihre App gruppieren, verbergen, Nachrichten senden, skripten, proxy und mit Ionic-UI schichten kann.

Wenden Sie es an, wenn die Seite mehr als eine einfache externe Browser-Anwendung benötigt: OAuth- und Checkout-Flüsse, eingebettete Support-Portale, Zahlungspläne, Videounterhaltungen, Dokumentportale, interaktive Webanwendungen oder jede Fluss, bei der Ihre App native Steuerelemente um lebendige Webinhalte benötigt.

Paketname geändert.

Gemeinsame Anwendungsfälle

• Präsentieren Sie Ionic- oder Capacitor-UI über einer lebenden Browser-Seite mit toBack, sendToBack(), bringToFront(), transparentBackground, und dispatchInputEvent().
• Mit Capgo können Sie Teilbildschirmbrowser, untere Blätter und Bild-in-Bild-Webviews erstellen width, height, x, y, und updateDimensions().
• Benutzen Sie die Capacitor App außerhalb eines benutzerdefinierten Browser-Frames auf Android und iOS.
• Verwenden Sie Capgo, um ohne persistente Website-Speicherung Einkaufs-, Anmelde-, Support- oder Kontoswitching-Flüsse auszuführen. persistWebViewData: false , clearAllBrowsingData().
• Bewahren Sie mehrere Browserinstanzen im Lauf. hidden, hide(), und show() während des Erhalts der Seitenzustände.
• Einbetten Sie fortschrittliche Web-Anwendungen, die eine Anfrage-Proxying, Datei-Uploads, -Downloads, Popup-Kontrolle und Google Pay-Unterstützung benötigen. _blank Link-Handling und App-zu-Seiten-Kommunikation.

Kernfunktionen

• open - Öffnet eine URL in Chrome Custom Tabs auf Android oder SFSafariViewController auf iOS.
• openWebView - Öffnet eine verwaltete native WebView mit benutzerdefinierter Toolbar, Größe, nativer Navigation, Messaging, Skriptierung, Proxy, Downloads, Popups und Datensteuerung.
• sendToBack / bringToFront - Verschiebt einen verwalteten Browser hinter oder über die Capacitor Host-WebView.
• dispatchInputEvent - Ändert die Größe und Position der verwalteten WebView ohne das Laden der Seite.
• updateDimensions - Halten verwaltete WebViews geladen, während die nativen Darstellung entfernt oder wiederhergestellt wird.
• hide / show - Verbindet die __CAPGO_KEEP_0__ App mit JavaScript, das innerhalb der verwalteten Seite läuft.
• postMessage / executeScript - Verbindet die Capacitor App mit JavaScript, das innerhalb der verwalteten Seite ausgeführt wird.
• clearAllBrowsingData / persistWebViewData - Steuert Cookies, Cache, Speicher, IndexedDB und Sitzungs persistence.
• handleDownloadsUnterstützt Dokumentportale, Upload-Flüsse, Zahlungsseiten und eingebettete Webanwendungen.

Öffentliche API

Methode	Beschreibung
goBack	Navigiert zurück in der WebView-Historie, wenn möglich.
open	Öffnet die URL in einem neuen Fenster im Vollbildmodus, auf Android wird Chrome Custom Tabs verwendet, auf iOS wird SFSafariViewController verwendet.
clearCookies	Löscht Cookies der URL Wenn id wird nicht angegeben, gilt für alle geöffneten WebViews.
clearAllCookies	Löscht alle Cookies Wenn id wird nicht angegeben, gilt für alle geöffneten WebViews.
clearCache	Löscht den Cache Wenn id wird nicht angegeben, gilt für alle geöffneten WebViews.
clearAllBrowsingData	Löscht Cookies, Cache, lokale Speicherung, Sitzungs-Speicherung, IndexedDB und andere Browsing-Daten aus der Standard-Speicherung und verwalteten WebViews.
getCookies	Holt Cookies für eine bestimmte URL.
close	Schließen Sie die Webansicht. Wenn id ist weggelassen, schließt sie die aktive Webansicht.
hide	Die Webansicht verbergen, ohne sie zu schließen. Verwenden Sie show() zum Zurückholen. Wenn id ist weggelassen, richtet sich auf die aktive Webansicht.
show	Zeigen Sie eine zuvor versteckte Webansicht. Wenn id ist weggelassen, richtet sich auf die aktive Webansicht.
sendToBack	Verschiebt die native Browser-Funktion hinter dem Capacitor Host-WebView, sodass die App-UI darüber erscheint.
bringToFront	Verschiebt einen Browser, der hinter der Host-WebView war, wieder nach vorne.
dispatchInputEvent	Übermittelt Klick-, Touch- oder Scroll-Eingaben an einen verwalteten Browser; die Koordinaten sind relativ zum Browser-Bildschirm.
openWebView	Öffnet eine URL in einer neuen Webansicht mit Werkzeugleisten und erweiterten Funktionen, wie Zugriff auf die Kamera, Dateizugriff, Ereignisablauf, JavaScript-Injecting, bidirektionale Kommunikation usw.
executeScript	Fügt JavaScript code in die InAppBrowser-Fenster ein. Wenn id is omitted, executes in all open webviews.
postMessage	Sendet ein Ereignis an das Webview (In-Browser). Hören Sie im Fenster mit window.addEventListener('messageFromNative', listenerFunc)Die detail Der Payload muss JSON-seriellierbar sein. Wenn id ist weggelassen, wird an alle geöffneten Webviews gesendet.
takeScreenshot	Fängt das aktuelle Webview-Viewport als PNG-Bildschirmfoto ein. Wenn id ist weggelassen, wird das aktive Webview angegangen.
setUrl	Setzt die URL des Webviews. Wenn id ist weggelassen, wird das aktive Webview angegangen.
addListener	Hören Sie sich für URL-Änderungen nur für geöffnete Webviews an.
addListener	Hören Sie sich für buttonNearDoneClick; der Payload enthält das Webview id.
addListener	Erhöre nur das Schließen für geöffnete WebViews.
addListener	Wird ausgelöst, wenn der Benutzer auf den Bestätigungsbutton klickt, wenn eine Erklärung erforderlich ist, funktioniert mit openWebView shareDisclaimer und closeModal.
addListener	Wird ausgelöst, wenn die WebView ein Ereignis an die App zurücksendet. Verwende window.mobileApp.postMessage(...) in der Seite und halte den Payload JSON-seriellierbar.
addListener	Wird ausgelöst, sobald ein Screenshot vom Plugin API, dem native Screenshot-Button oder der injizierten JavaScript-Brücke aufgenommen wird.
addListener	Wird ausgelöst, wenn die Seite geladen wird.
addListener	Wird ausgelöst, wenn eine Seite nicht geladen werden kann.
addListener	Wird ausgelöst, nachdem native Download-Handling eine Datei lokal gespeichert hat. Aktiviere dies mit handleDownloads: true wenn die WebView geöffnet wird.
addListener	Wird ausgelöst, wenn native Download-Handling fehlschlägt. Aktiviere dies mit handleDownloads: true wenn die WebView geöffnet wird.
addListener	Wird ausgelöst, wenn eine Seite ein Popup/Neues Fenster öffnet. Verwende den zurückgegebenen Popup-Id mit executeScript, postMessage, show, hide, und close.
addListener	Hören Sie auf proxied Anfragen, die durch den native Runtime delegiert werden. Vorzuziehen addProxyHandler() anstatt dies direkt aufzurufen.
addListener	Hören Sie auf JavaScript-Konsolenausgaben, die durch die verwaltete Seite emittiert werden. Aktivieren Sie dies mit captureConsoleLogs: true wenn Sie die Webview öffnen.
handleProxyRequest	Internes Verfahren, das von addProxyHandler() zurück an die native senden. Weiterleiten des Originals phase wieder, wenn Sie auf eine manuelle proxyRequest Zuhörer.
removeAllListeners	Entfernen Sie alle Zuhörer für dieses Plugin.
reload	Laden Sie die aktuelle Webseite neu.
updateDimensions	Aktualisieren Sie die Abmessungen der Webview. Erstreckt sich die Größe und Position der Webview im Laufe der Zeit. Wenn id wird übersprungen, zielt auf die aktive WebView ab.
setEnabledSafeTopMargin	Setzt die aktivierten oberen Sicherheitsabstand der Webbiew bei Laufzeit. Wenn id zielt auf die aktive Webbiew. Auf Web ist diese Methode ein No-Op und löst ohne Layoutänderung auf.
setEnabledSafeBottomMargin	Setzt die aktivierten unteren Sicherheitsabstand der Webbiew bei Laufzeit. Wenn id zielt auf die aktive Webbiew. Auf Web ist diese Methode ein No-Op und löst ohne Layoutänderung auf.
openSecureWindow	Öffnet eine sichere OAuth2-Fenster. Auf Web wird die umgeleitete URL durch ein BroadcastChannel; auf Mobilgeräten wird ein benutzerdefinierter Umleitungs-URI in der App-Konfiguration registriert. Siehe die Anleitung zum Starten für die vollständige HTML, Info.plist und AndroidManifest Beispiele.

Werteverzeichnis

Verwenden Sie diese Werte mit Toolbar-Optionen, wenn Sie ein In-App-Browser oder WebView öffnen.

Toolbar-Typen

Wert	Der Benutzer findet
activity	Einfache Toolbar mit Schließen- und Teilen-Steuerungen.
compact	Einfache Toolbar mit einer Schließen-Steuerung.
navigation	Vollständige Navigationstoolbar mit Zurück- und Vorwärts-Steuerungen.
blank	Keine Toolbar.

Quelle der Wahrheit

Diese Referenz wird von src/definitions.ts in capacitor-in-app-Browser.

Weitergehen von @capgo/capacitor-in-app-Browser

Wenn Sie das Plugin verwenden @capgo/capacitor-InAppBrowser um native Plugin-Arbeit zu planen, verbinden Sie es mit Mit @capgo/capacitor-InAppBrowser für die native Fähigkeit in Mit @capgo/capacitor-InAppBrowser Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins, und Ionic Enterprise Plugin Alternativen für das Produktworkflow in Ionic Enterprise Plugin Alternativen.