@capgo/capacitor-inappbrowser

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

Verwenden Sie es, wenn die Seite mehr als eine einfache externe Browserfunktion benötigt: OAuth- und Checkout-Flüsse, eingebettete Supportportale, Zahlungsbildschirme, Videounterhaltungen, Dokumentportale, interaktive Webanwendungen oder jede Fluss, bei dem Ihre App native Steuerelemente um lebendige Webinhalte benötigt.

Der Paketname wurde geändert.

Häufige Verwendungsfälle

• Präsentieren Sie Ionic oder Capacitor-UI über einer lebenden Browserseite mit toBack, sendToBack(), bringToFront(), transparentBackgroundund dispatchInputEvent().
• Erstellen Sie Browser, die nur einen Teil des Bildschirms einnehmen, sowie Schubladen und Webansichten im Bildschirmmodus mit width, height, x, yund updateDimensions().
• Lassen Sie die Benutzer auf Android- und iOS-Geräten den Capacitor-App außerhalb eines Browser-Frames mit einer benutzerdefinierten Größe anklicken.
• Ausführen von Checkout-, Login-, Support- oder Account-Wechsel-Flows ohne persistente Website-Speicherung mit persistWebViewData: false und clearAllBrowsingData().
• Beibehalten Sie mehrere Browser-Instanzen mit hidden, hide()und show() beim Erhalten der Seitenzustände.
• Einbetten von Webanwendungen, die eine Anforderungsproxying, Dateiuploads, Downloads, Popupsteuerung, Google Pay-Unterstützung, _blank Link-Handling und App-zu-Seiten-Messaging benötigen.

Kernfunktionen von Capgo

• open - Öffnet eine URL in Chrome Custom Tabs auf Android oder SFSafariViewController - Öffnet eine verwaltete native WebView mit benutzerdefinierter Toolbar, Größe, nativer Navigation, Messaging, Skripting, Proxy, Downloads, Pop-ups und Datensteuerung.
• openWebView - Bewegt eine verwaltete Browser dahinter oder über der __CAPGO_KEEP_0__ Host-WebView.
• sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
• dispatchInputEvent - Ändert die Größe und Position der verwalteten WebView ohne das Seitenaufrufen.
• updateDimensions - Halte die verwalteten WebViews geladen, während die native Darstellung entfernt oder wiederhergestellt wird.
• hide / show - Verbindet die __CAPGO_KEEP_0__ App mit JavaScript, das innerhalb der verwalteten Seite läuft.
• postMessage / executeScript - Connects the Capacitor app with JavaScript running inside the managed page.
• clearAllBrowsingData / persistWebViewData , Proxy-Regeln und Pop-up-Ereignisse - Unterstützt Dokumentportale, Upload-Flüsse, Zahlungsseiten und eingebettete Webanwendungen.
• handleDownloadsÖffentliche __CAPGO_KEEP_0__

Public API

Methode	Beschreibung
goBack	Navigiert 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ö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 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	Erhalte Cookies für eine bestimmte URL.
close	Schließe die Webansicht. Wenn id ist weggelassen, schließt die aktive Webansicht.
hide	Mache die Webansicht unsichtbar, ohne sie zu schließen. Verwende show() , um sie wieder zu aktivieren. Wenn id ist weggelassen, wird die aktive Webansicht angegangen.
show	Zeige eine zuvor versteckte Webansicht. Wenn id ist weggelassen, wird die aktive Webansicht angegangen.
sendToBack	Verschiebt den native Browser hinter der Capacitor Host-WebView, damit die App-UI über ihr erscheint.
bringToFront	Verschiebt einen Browser, der hinter der Host-WebView war, wieder in den Vordergrund.
dispatchInputEvent	Sendet Klick-, Touch- oder Scroll-Eingaben an eine verwaltete Browser; die Koordinaten sind relativ zum Browser-Viewport.
openWebView	Öffnet die URL in einer neuen Webansicht mit Werkzeugleisten und erweiterten Funktionen, wie Zugriff auf die Kamera, Zugriff auf Dateien, Ereignis-Abonnements, JavaScript-Injecting, bidirektionale Kommunikation usw.
executeScript	Injects JavaScript code in die InAppBrowser-Fenster. Wenn id wird übersprungen, wird in allen geöffneten Webviews ausgeführt.
postMessage	Sendet ein Ereignis an die Webview (In-App-Browser). Hören Sie im Fenster mit window.addEventListener('messageFromNative', listenerFunc)Die detail Der Payload muss JSON-seriellierbar sein. Wenn id Übersendet an alle geöffneten Webviews.
takeScreenshot	Fängt das aktuelle Webview-Bildschirmfenster als PNG-Screenshot ein. Wenn id Übersendet an das aktive Webview-Fenster.
setUrl	Setzt die URL der Webview. Wenn id Hören Sie sich auf die URL-Änderung an, nur für geöffnete Webviews.
addListener	Hören Sie sich auf
addListener	; der Payload enthält die Webview buttonNearDoneClickHört sich auf die URL-Änderung an, nur für geöffnete Webviews. id.
addListener	Erhöht nur die Schließen-Klick für geöffnetes WebView.
addListener	Wird ausgelöst, wenn der Benutzer auf den Bestätigungs-Button klickt, wenn eine Erklärung erforderlich ist, funktioniert mit openWebView shareDisclaimer und closeModal.
addListener	Wird ausgelöst, wenn das WebView einen Ereignis zurück an die App sendet. Verwende window.mobileApp.postMessage(...) in der Seite und behalte die 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 die Seite ein Ladenfehler aufweist.
addListener	Wird ausgelöst, nachdem native Download-Handling eine Datei lokal gespeichert hat. Aktiviere dies mit handleDownloads: true wenn du das WebView öffnest.
addListener	Wird ausgelöst, wenn native Download-Handling fehlschlägt. Aktiviere dies mit handleDownloads: true wenn du das WebView öffnest.
addListener	Wird ausgelöst, sobald eine Seite ein Popup/Neues Fenster öffnet. Verwende die zurückgegebene Popup-ID mit executeScript, postMessage, show, hide, und close.
addListener	Listen auf proximierte Anfragen, die durch den native Runtime delegiert werden. Vorziehen addProxyHandler() anstatt diese direkt aufzurufen.
addListener	Listen 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() verwendet wird, um eine Proxyentscheidung an die native Seite zurückzusenden. Weitergeben Sie die ursprüngliche phase wenn Sie auf eine manuelle proxyRequest Hinweisgeber antworten.
removeAllListeners	Entfernen Sie alle Listener für dieses Plugin.
reload	Laden Sie die aktuelle Web-Seite neu.
updateDimensions	Aktualisieren Sie die Abmessungen der Webview. Es ermöglicht das Ändern der Größe und Position der Webview im Laufe der Zeit. Wenn id wird übersprungen, zielt auf das aktive WebView.
setEnabledSafeTopMargin	Setzt die aktivierten oberen sicheren Abstandsmarge des Webbrowsers während der Laufzeit. Wenn id wird übersprungen, zielt auf das aktive WebView. Auf Web ist diese Methode ein No-Op und löst ohne Layoutänderung auf.
setEnabledSafeBottomMargin	Setzt die aktivierten unteren sicheren Abstandsmarge des Webbrowsers während der Laufzeit. Wenn id wird übersprungen, zielt auf das aktive WebView. Auf Web ist diese Methode ein No-Op und löst ohne Layoutänderung auf.
openSecureWindow	Öffnet ein sicheres OAuth2-Fenster. Auf Web gibt die Methode die umgeleitete URL zurück, während BroadcastChannelauf Mobilgeräten einen benutzerdefinierten Umleitungs-URI in der App-Konfiguration registrieren. Siehe die Anleitung zum Starten für das vollständige HTML, Info.plist und AndroidManifest-Beispiel.

Referenzwerte

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

Toolbar-Typen

Wert	Der Benutzer findet
activity	Ein einfaches Toolbar mit Schließen- und Teilen-Steuerungen.
compact	Ein einfaches Toolbar mit einer Schließen-Steuerung.
navigation	Eine vollständige Navigation-Toolbar mit Zurück- und Vorwärts-Steuerungen.
blank	Keine Toolbar.

Quelle der Wahrheit

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

Weitergehen von @capgo/capacitor-inappbrowser

Wenn Sie @capgo/capacitor-inappbrowser zum Planen von native Plugin-Arbeiten verwenden, verbinden Sie es mit Mit @capgo/capacitor-inappbrowser zum native Capability in Mit @capgo/capacitor-inappbrowser, Capgo Plugin-Verzeichnis zum Produktworkflow in Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo zum Implementierungsdetail in Capacitor Plugins von Capgo, Hinzufügen oder Aktualisieren von Plugins zum Implementierungsdetail in Hinzufügen oder Aktualisieren von Plugins, und Alternativen zum Ionic Enterprise Plugin für den Produktworkflow in Alternativen zum Ionic Enterprise Plugin.