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 größen, 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 die Ionic- oder Capacitor-Oberfläche über einer lebenden Browserseite. 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 die Benutzer auf Capacitor außerhalb eines Browserrahmens mit einer benutzerdefinierten Größe auf Android und iOS klicken.
  • Führen Sie Checkout-, Login-, Support- oder Account-Wechsel-Flüsse ohne persistente Website-Speicherung mit persistWebViewData: false und clearAllBrowsingData().
  • Mit mehreren Browserinstanzen beladen halten hidden, hide(), und show() während der Erhaltung der Seitenzustände.
  • 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 - 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 Abschnitt mit dem Titel “Core Leistungen”
  • 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- Proxy-Regeln und Popup-Ereignisse - Unterstützt Dokumentportale, Upload-Flüsse, Zahlungsseiten und eingebettete Webanwendungen.
- Methode- Beschreibung
goBack- Navigation zurück in der WebView-Geschichte, 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öschet 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 die Webview. Wenn id wird übersprungen, schließt die aktive Webview.
hideVerstecke die Webview ohne sie zu schließen. Verwende show() um sie wieder zu öffnen. Wenn id wird übersprungen, zielt auf die aktive Webview.
showZeige 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 darüber 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 Browser mit window.addEventListener('messageFromNative', listenerFunc)auf. Der detail Payload 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ätigungsbutton klickt, wenn eine Warnung 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 behalte den Payload als JSON-seriellierbar.
addListenerWird ausgelöst, wenn ein Screenshot vom Plugin API, dem native Screenshot-Button oder der injizierten 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 eine neue Fenster öffnet. Verwenden Sie den zurückgegebenen Popup-Id mit
addListenerWird ausgelöst, wenn die native Dateiübertragung fehlschlägt. Aktivieren Sie dies mit handleDownloads: true Wird ausgelöst, wenn eine Seite eine neue Fenster öffnet. Verwenden Sie den zurückgegebenen Popup-Id mit
addListener, und executeScript, postMessage, show, hideHören Sie auf proxied Anfragen, die durch die native Runtime delegiert werden. Präferieren Sie close.
addListeneranstatt dies direkt aufzurufen. addProxyHandler() Hören Sie auf JavaScript-Konsolen-Ausgaben, die von der verwalteten Seite emittiert werden. Aktivieren Sie dies mit
addListenerWird ausgelöst, wenn eine Seite eine neue Fenster öffnet. Verwenden Sie den zurückgegebenen Popup-Id mit captureConsoleLogs: true Wird von
handleProxyRequestintern verwendet. addProxyHandler() eine Proxyentscheidung an die native zurückzusenden. Fördert das Original phase wenn man auf eine manuelle antwortet proxyRequest Hörer.
removeAllListenersEntfernt alle Hörer für diesen Plugin.
reloadLädt die aktuelle Web-Seite neu.
updateDimensionsAktualisiert die Dimensionen des Webviews. Erlaubt die Änderung der Größe und Position des Webviews im Laufzeit. id wird weggelassen, zielt auf das aktive Webview.
setEnabledSafeTopMarginSetzt die aktivierten oberen sicheren Randmarke des Webviews im Laufzeit. Wird weggelassen, zielt auf das aktive Webview. Auf Web, ist diese Methode ein No-Op und löst ohne Änderung der Layout auf. id Setzt die aktivierten unteren sicheren Randmarke des Webviews im Laufzeit. Wird weggelassen, zielt auf das aktive Webview. Auf Web, ist diese Methode ein No-Op und löst ohne Änderung der Layout auf.
setEnabledSafeBottomMarginÖffnet eine sichere OAuth2-Fenster. Auf Web, gibt es die umgeleitete URL durch ein id __CAPGO_KEEP_0__
openSecureWindow__CAPGO_KEEP_0__ 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-in-app-Browser.

Wenn Sie native Plugin-Arbeiten planen, verbinden Sie es mit @capgo/capacitor-in-app-Browser zur Verwendung von @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-in-app-Browser für die native Fähigkeit in Using @capgo/capacitor-in-app-Browser Wenn Sie native Plugin-Arbeiten planen, verbinden Sie es mit @capgo/capacitor-in-app-Browser Capgo Plugin-Verzeichnis zur Produktionsablauf in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo zur Implementierungsdetails in Capacitor Plugins von Capgo Plugins hinzufügen oder aktualisieren zur Implementierungsdetails in Plugins hinzufügen oder aktualisieren, und Ionische Unternehmens-Plugin-Alternativen zur Produktionsablauf in Ionische Unternehmens-Plugin-Alternativen.