Zum Inhalt springen

@capgo/capacitor-in-app-Browser

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

@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 gruppieren, verbergen, Nachrichten senden, skripten, proxy und mit Ionic UI schichten kann.

Verwenden Sie es, wenn die Seite mehr als eine einfache externe Browseranwendung benötigt: OAuth- und Checkout-Flüsse, eingebaute Supportportale, Zahlungsanzeigen, Videounterhaltungen, Dokumentportale, 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-Seitenelement mit toBack, sendToBack(), bringToFront(), transparentBackground, und dispatchInputEvent().
  • Erstellen Sie Browseranwendungen mit teilweitem Bildschirm, unteren Blättern und Bild-in-Bild-Webansichten mit width, height, x, y, und updateDimensions().
  • Lassen Sie Benutzer auf Capacitor außerhalb eines Browserrahmens 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, während die Seite erhalten bleibt. hidden, hide(), und show() während die Seite erhalten bleibt.
  • Integriere fortschrittliche Webanwendungen, die eine Anforderungsproxying, Dateiuploads, Downloads, Popupsteuerung, Google Pay-Unterstützung, Linkverarbeitung und App-zu-Seiten-Meldungen 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 - Verschiebt 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 Core Capabilities
  • updateDimensions - Ändert die Größe und Position des verwalteten WebView ohne das Laden der 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- Regeln für Proxy und Ereignisse von Pop-ups - Unterstützt Dokumentportale, Upload-Flüsse, Zahlungsseiten und eingebettete Webanwendungen.
- Methode- Beschreibung
goBack- Navigation zurück in der Historie des WebViews, 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- und verwalteten WebViews löschen.
getCookiesHolt Cookies für eine bestimmte URL.
closeSchließen Sie die Webview. Wenn id wird übersprungen, schließt die aktive Webview.
hideVerstecken Sie die Webview ohne sie zu schließen. Verwenden Sie show() um sie wieder zu öffnen. Wenn id wird übersprungen, zielt auf die aktive Webview.
showZeigen Sie eine zuvor versteckte Webview an. 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, Dateizugriff, Ereignis-Abonnements, JavaScript-Injecting, bidirektionale Kommunikation usw.
executeScriptFügt JavaScript code in das InAppBrowser-Fenster ein. Wenn id übersprungen wird, wird es 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 übersprungen wird, wird es an alle geöffneten WebViews weitergeleitet.
takeScreenshotFängt das aktuelle WebView-Viewport als PNG-Bildschirmfoto 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 auf nur für close click bei openWebView.
addListenerWird ausgelöst, wenn der Benutzer auf den Bestätigungsbutton 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, wenn ein Screenshot vom Plugin API, der native Screenshot-Button oder die injizierte JavaScript-Brücke aufgenommen wird.
addListenerWird ausgelöst, wenn die Seite geladen ist.
addListenerWird ausgelöst, wenn eine Seitenbeladungsfehler auftritt.
addListenerWird ausgelöst, nachdem die native Dateiübertragung eine Datei lokal gespeichert hat. Aktivieren Sie dies mit handleDownloads: true Wird ausgelöst, wenn eine Seite beim Öffnen der Webview geöffnet wird.
addListenerWird ausgelöst, wenn die native Dateiübertragung fehlschlägt. Aktivieren Sie dies mit handleDownloads: true Wird ausgelöst, wenn eine Seite beim Öffnen der Webview geöffnet wird.
addListenerWird ausgelöst, wenn eine Seite ein Popup/Neues Fenster öffnet. Verwenden Sie die zurückgegebene Popup-ID mit executeScript, postMessage, show, hideund close.
addListenerHören Sie auf proxied Anfragen, die durch die native Runtime delegiert werden. Präferieren Sie addProxyHandler() anstatt dies direkt aufzurufen.
addListenerHören Sie auf JavaScript-Konsolenausgaben, die durch die verwaltete Seite emittiert werden. Aktivieren Sie dies mit captureConsoleLogs: true wenn die Webview geöffnet wird.
handleProxyRequestMethode, die intern von 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 ist weggelassen, zielt es auf den aktiven Web-View.
setEnabledSafeTopMarginSetzt die aktivierbare sichere obere Randmarke des Web-Views im Laufe der Zeit. Wenn id ist weggelassen, zielt es auf den aktiven Web-View. Auf Web ist diese Methode ein No-Op und löst ohne Änderung der Layout ohne Änderung.
setEnabledSafeBottomMarginSetzt die aktivierbare sichere untere Randmarke des Web-Views im Laufe der Zeit. Wenn id ist weggelassen, zielt es auf den aktiven Web-View. Auf Web ist diese Methode ein No-Op und löst ohne Änderung der Layout ohne Änderung.
openSecureWindowÖffnet eine sichere OAuth2-Fenster. Auf Web, gibt es die durchgeführte URL zurück durch ein BroadcastChannel; auf Mobilgeräten registrieren Sie eine benutzerdefinierte Umleitungs-URI in Ihrer Anwendungs-Konfiguration. Siehe die Anleitung zum Einrichten für die vollständige HTML, Info.plist und AndroidManifest-Beispiele.

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-Steuerungen.
compactEinfache Toolbar mit einer Schließen-Steuerung.
navigationVollständige Navigationstoolbar mit Zurück- und Vorwärts-Steuerungen.
blankKeine Toolbar.

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

Wenn Sie native Plugin-Arbeit planen, verbinden Sie es mit @capgo/capacitor-inappbrowser zur Verwendung von @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-inappbrowser für die native Fähigkeit in Using @capgo/capacitor-inappbrowser Wenn Sie native Plugin-Arbeit planen, verbinden Sie es mit @capgo/capacitor-inappbrowser Capgo Plugin-Verzeichnis für den Produktworkflow im Capgo Plugin-Verzeichnis Capacitor Plugins durch Capgo für die Implementierungsdetails in Capacitor Plugins durch 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 den Produktworkflow in Ionic Enterprise Plugin Alternativen.