Zum Inhalt springen

@capgo/capacitor-in-app-Browser

Nativ in-app-Browser für Capacitor mit verwaltetem WebView, nativer Benutzeroberfläche, privaten Sitzungen, Proxying, Downloads, Pop-ups und App-Nachrichten

Übersicht

Übersicht

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

Verwenden Sie es, wenn die Seite mehr als eine einfache externe Browser-Anwendung benötigt: OAuth- und Checkout-Flüsse, eingebaute Support-Portale, Zahlungsanzeigen, Videounterhaltungen, Dokument-Portale, interaktive Webanwendungen oder jede Fluss, bei der Ihre App native Steuerelemente um lebendige Webinhalte benötigt.

Der Paketname wurde geändert.
  • Präsentieren Sie Ionic oder Capacitor-UI über einem lebenden Browser-Seite mit toBack, sendToBack(), bringToFront(), transparentBackground, und dispatchInputEvent().
  • Erstellen Sie Browser-Anwendungen mit teilweitem Bildschirm, unteren Blättern und Bild-in-Bild-Webviews mit width, height, x, y, und updateDimensions().
  • Lassen Sie Benutzer auf Capacitor-App außerhalb eines Browser-Frames mit einer benutzerdefinierten Größe auf Android und iOS klicken.
  • Führen Sie Checkout-, Login-, Support- oder Konto-Wechsel-Flüsse ohne persistente Website-Speicherung mit persistWebViewData: false und clearAllBrowsingData().
  • Mit mehreren Browserinstanzen laden, hidden, hide(), und show() während des Erhalts der Seitenzustände.
  • Integriere fortschrittliche Webanwendungen, die eine Anforderungsproxying, Dateiuploads, Downloads, Popupsteuerung, Google Pay-Unterstützung, Linkverwaltung und App-zu-Seiten-Messaging benötigen. _blank Kernfunktionen

Abschnitt mit dem Titel “Kernfunktionen”

- Öffnet eine URL in Chrome Custom Tabs auf Android oder
  • open - Öffnet einen verwalteten nativen WebView mit einer benutzerdefinierten Toolbar, Größe, nativer Navigation, Messaging, Skriptierung, Proxy, Downloads, Popups und Datensteuerung. SFSafariViewController - Bewegt einen verwalteten Browser hinter oder über den __CAPGO_KEEP_0__ Host-WebView.
  • openWebView - Leitet Klick-, Touch- und Scrollereignisse an einen Browser weiter, der hinter der nativen App-UI liegt.
  • sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
  • dispatchInputEvent Section titled “Core Capabilities”
  • updateDimensions - Ändert die Größe und Position des verwalteten WebView ohne das Laden einer neuen Seite.
  • hide / show - Halten Sie verwaltete WebViews geladen, während Sie sie entfernen oder ihre native Darstellung wiederherstellen.
  • postMessage / executeScript - Verbindet die Capacitor-App mit JavaScript, das innerhalb des verwalteten Seitenbereichs ausgeführt wird.
  • clearAllBrowsingData / persistWebViewData - Steuert Cookies, Cache, Speicher, IndexedDB und Sitzungs persistence.
  • handleDownloads- Proxy-Regeln und Popup-Ereignisse - Unterstützt Dokument-Portale, Upload-Flüsse, Zahlungsseiten und eingebettete Webanwendungen.
- 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 die Cookies der URL, wenn id wird übersprungen, gilt für alle geöffneten Webviews.
clearAllCookiesAlle Cookies löschen Wenn id wird übersprungen, gilt für alle geöffneten Webviews.
clearCacheCache löschen Wenn id wird übersprungen, gilt für alle geöffneten Webviews.
clearAllBrowsingDataCookies, Cache, lokale Speicherung, Sitzungs-Speicherung, IndexedDB und andere Browsing-Daten aus dem Standard-Store und verwalteten WebViews löscht.
getCookiesHolt Cookies für eine bestimmte URL.
closeSchließe das Webview. Wenn id wird übersprungen, schließt das aktive Webview.
hideVerstecke das Webview ohne es zu schließen. Verwende show() um es wieder zu öffnen. Wenn id wird übersprungen, zielt auf das aktive Webview.
showZeige ein zuvor verstecktes Webview. Wenn id wird übersprungen, zielt auf das aktive WebView.
sendToBackVerschiebt den native Browser hinter dem Capacitor Host-WebView, damit die App-UI über ihm erscheint.
bringToFrontVerschiebt einen Browser, der hinter dem Host-WebView stand, wieder nach vorne.
dispatchInputEventÜbermittelt Klick-, Touch- oder Scroll-Eingaben an einen verwalteten Browser; die Koordinaten sind relativ zum Browser-Viewport.
openWebViewÖffnet eine URL in einem neuen WebView mit Werkzeugleisten und erweiterten Funktionen, wie Zugriff auf die Kamera, Dateien, Ereignis-Abonnements, JavaScript-Injecting und bidirektionale Kommunikation usw.
executeScriptFügt JavaScript code in das InAppBrowser-Fenster ein. Wenn id wird übersprungen, wird in allen geöffneten WebViews ausgeführt.
postMessageSendet ein Ereignis an das WebView (In-App-Browser). Hören Sie im Seite mit window.addEventListener('messageFromNative', listenerFunc)auf. Der detail Muss JSON-seriellierbar sein. Wenn id wird übersprungen, wird an alle geöffneten WebViews ausgestrahlt.
takeScreenshotFängt das aktuelle WebView-Viewport als PNG-Screenshot ein. Wenn id wird übersprungen, zielt auf die aktive WebView.
setUrlSetzt die URL der WebView. Wenn id wird übersprungen, zielt auf die aktive WebView.
addListenerHört auf URL-Änderungen, nur für openWebView.
addListenerHört auf buttonNearDoneClick ; der Payload enthält die WebView id.
addListenerHört nur auf Schließen-Klick für openWebView.
addListenerWird ausgelöst, wenn der Benutzer auf den Bestätigungs-Button klickt, wenn ein Hinweis erforderlich ist, funktioniert mit openWebView shareDisclaimer und closeModal.
addListenerWird 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.
addListenerWird ausgelöst, sobald ein Screenshot vom Plugin API, der native Screenshot-Button oder die injizierte JavaScript-Brücke aufgenommen wird.
addListenerWird ausgelöst, wenn die Seite geladen wird.
addListenerWird ausgelöst, wenn eine Seitenladefehler auftritt.
addListenerWird ausgelöst, nachdem die native Dateiübertragung eine Datei lokal gespeichert hat. Aktivieren Sie dies mit handleDownloads: true Wird ausgelöst, wenn die native Dateiübertragung fehlschlägt. Aktivieren Sie dies mit
addListenerWird ausgelöst, wenn eine Seite ein Popup/Neues Fenster öffnet. Verwenden Sie die zurückgegebene Popup-ID mit handleDownloads: true und
addListenerHören Sie auf proxied Anfragen, die durch die native Runtime delegiert werden. Präferieren Sie executeScript, postMessage, show, hideanstatt dies direkt aufzurufen. close.
addListenerHören Sie auf JavaScript-Konsolenausgaben, die durch die verwaltete Seite emittiert werden. Aktivieren Sie dies mit addProxyHandler() wenn Sie die Webview öffnen.
addListenerMethode, die intern von captureConsoleLogs: true Capgo verwendet wird.
handleProxyRequestWird ausgelöst, wenn eine Seite ein Popup/Neues Fenster öffnet. Verwenden Sie die zurückgegebene Popup-ID mit addProxyHandler() eine Proxyentscheidung an die native zurückzusenden. Fördern Sie das Original phase wenn man auf eine manuelle antwortet proxyRequest Hörer.
removeAllListenersEntfernen Sie alle Hörer für dieses Plugin.
reloadLaden Sie die aktuelle Web-Seite neu.
updateDimensionsAktualisieren Sie die Dimensionen des Web-Views. Es ermöglicht die Änderung der Größe und Position des Web-Views im Laufe der Zeit. Wenn id setzt die aktivierten sichere obere Randmarke des Web-Views im Laufe der Zeit. Wenn
setEnabledSafeTopMarginsetzt die aktivierten sichere untere Randmarke des Web-Views im Laufe der Zeit. Wenn id Öffnet eine sichere OAuth2-Fenster. Auf Web, gibt die zurückgeleitete URL durch ein
setEnabledSafeBottomMarginsetzt die aktivierten sichere obere Randmarke des Web-Views im Laufe der Zeit. Wenn id setzt die aktivierten sichere untere Randmarke des Web-Views im Laufe der Zeit. Wenn
openSecureWindowÖffnet eine sichere OAuth2-Fenster. Auf Web, gibt die zurückgeleitete URL durch ein BroadcastChannel; auf Mobilgeräten registrieren Sie eine benutzerdefinierte Umleitungs-URI in Ihrer Anwendungs-Konfiguration. Siehe die Anleitung zum Einrichten für das vollständige HTML, Info.plist und AndroidManifest-Beispiel.

Verwenden Sie diese Werte mit den Toolbar-Optionen, wenn Sie einen in-app-Browser oder WebView öffnen.

WertDer Benutzer findet
activityEinfache Toolbar mit Schließen- und Teilen-Kontrollen.
compactEinfache Toolbar mit einer Schließen-Kontrolle.
navigationVollständige Navigationstoolbar mit Zurück- und Vorwärts-Kontrollen.
blankKeine Toolbar.

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

Wenn Sie native Plugin-Arbeiten planen, verbinden Sie es mit @capgo/capacitor-inappbrowser für die native Fähigkeit in @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-inappbrowser für die native Fähigkeit in @capgo/capacitor-inappbrowser für die native Fähigkeit in @capgo/capacitor-inappbrowser Plugin-Verzeichnis von Capgo 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-Unternehmens-Plugin-Alternativen für den Produktworkflow in Ionic-Unternehmens-Plugin-Alternativen.