Erste Schritte
Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses Plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-inappbrowser`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/inappbrowser/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Installieren
Abschnitt „Installation“Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsNutze dann diesen Prompt:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-inappbrowser` plugin in my project.Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:
npm install @capgo/capacitor-inappbrowsernpx cap syncImportieren
Abschnitt mit dem Titel „Import“import { InAppBrowser } from '@capgo/capacitor-inappbrowser';Quickstart: Gehosteter Checkout in einer verwalteten WebView
Abschnitt mit dem Titel „Schnellstart: Hosted Checkout in einer verwalteten WebView“import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.openWebView({ url: 'https://billing.example.com/checkout', toolbarType: 'navigation', title: 'Checkout',});
InAppBrowser.addListener('urlChangeEvent', (event) => { if (event.url.includes('/success')) { InAppBrowser.close(); }});Nutzt open() stattdessen, wenn Sie Safari View Controller oder Chrome Custom Tabs nutzen möchten, ohne einen kompletten nativen WebView-Stack einzubetten.
Wähle den Browser-Modus
Abschnitt mit dem Titel „Browser-Modus wählen“Nutzt open() wenn du die Browser-Oberfläche der Plattform nutzen möchtest: Chrome Custom Tabs auf Android und SFSafariViewController auf iOS. Verwende openWebView() wenn Ihre App die native WebView steuern muss: eigene Größe, Toolbar, App-Messaging, JavaScript-Injection, Downloads, Proxying, Popups, versteckte Instanzen oder UI-Layering.
Häufige Anwendungsfälle
Abschnitt mit dem Titel „Häufige Anwendungsfälle“Ionic UI über einer Live-Browserseite anzeigen
Abschnitt mit dem Titel „Ionic UI über einer Live-Browserseite anzeigen“Öffne die verwaltete WebView hinter der Capacitor Host-WebView mit toBack. Deine Ionic UI kann dann über der Seite gerendert werden, während der Web-Content im Hintergrund geladen bleibt. Leite Gesten an den Browser weiter mit dispatchInputEvent() wenn das Overlay mit der Seite interagieren soll.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/checkout', toBack: true, transparentBackground: true,});
await InAppBrowser.dispatchInputEvent({ id, type: 'click', x: 160, y: 420,});
await InAppBrowser.bringToFront({ id });Machen Sie den relevanten App-Hintergrund transparent, überall dort, wo der Browser sichtbar sein soll. Wenn der Browser hinter der App liegt, gehören native Gesten weiterhin der Capacitor-WebView, es sei denn, Sie leiten sie explizit weiter.
Teilbildschirm-Browser oder Bottom Sheet erstellen
Abschnitt mit dem Titel „Browser oder Bottom Sheet für den Teilbildschirm erstellen“Setzen Sie height, width, x, und y um einen Teil der Capacitor-App um den nativen Browser herum sichtbar zu halten. Auf Android und iOS werden Berührungen außerhalb des Browser-Rahmens an die darunterliegende Capacitor-WebView weitergeleitet.
const bottomGap = 200;
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/offers', height: window.innerHeight - bottomGap, y: 0,});
await InAppBrowser.updateDimensions({ id, height: window.innerHeight, y: 0,});Verwenden Sie dies für Mini-Browser, Angebots-Panel, Support-Widgets, Bottom Sheets mit Browser-Backend oder jeden Ablauf, bei dem die nativen App-Steuerungen außerhalb des Webinhalts antippenbar bleiben müssen.
Checkout-, Auth- oder Support-Sessions privat halten
Abschnitt mit dem Titel „Checkout-, Auth- oder Support-Sitzungen privat halten“Setzen Sie persistWebViewData: false für verwaltete WebViews, die persistente Website-Daten vermeiden sollen, sofern die Plattform dies unterstützt. Rufe clearAllBrowsingData() nach Logout, Konto-Wechsel, Test-Sitzungen oder in Flows auf, die den Standard-Store und geöffnete verwaltete WebViews leeren müssen.
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/login', persistWebViewData: false,});
await InAppBrowser.clearAllBrowsingData();await InAppBrowser.close({ id });Auf Android nutzen Cookies den Cookie-Store des System-WebViews, daher ist clearAllBrowsingData() der Aufräum-Schritt für Cookies und andere geteilte Browser-Daten.
Mehrere Browser-Instanzen bereithalten
Abschnitt mit dem Titel „Mehrere Browser-Instanzen bereit halten“Nutzt hidden, hide(), und show() um mehrere verwaltete WebViews vorzuladen oder zu erhalten, ohne jede einzelne auf dem Bildschirm zu halten. Versteckte WebViews können weiterhin executeScript(), postMessage(), setUrl()und Close-Aufrufe empfangen.
const first = await InAppBrowser.openWebView({ url: 'https://example.com/a', hidden: true });const second = await InAppBrowser.openWebView({ url: 'https://example.com/b', hidden: true });
await InAppBrowser.show({ id: first.id });await InAppBrowser.hide({ id: first.id });await InAppBrowser.show({ id: second.id });Fortgeschrittene Web-App-Flows einbetten
Abschnitt mit dem Titel „Erweiterte Web-App-Flows einbetten“Kombiniere Proxy-Regeln handleDownloads, openBlankTargetInWebView, hiddenPopupWindow, enableGooglePaySupport, postMessage(), und executeScript() für Dokumentenportale, Upload-Flows, Zahlungsseiten, Support-Desks und andere eingebettete Web-Apps, die native Kontrolle benötigen, ohne die App zu verlassen.
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/portal', handleDownloads: true, openBlankTargetInWebView: true, hiddenPopupWindow: true, outboundProxyRules: [ { urlRegex: '^https://example\\.com/api/', action: 'delegateToJs', }, ],});
await InAppBrowser.postMessage({ id, detail: { source: 'app', action: 'refresh' },});API Übersicht
Abschnitt „API Übersicht“goBack
Abschnitt „goBack“Navigiert in der WebView-Historie zurück, sofern möglich
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.goBack();open
Abschnitt „open“Öffnet die URL in einem neuen Vollbildfenster; auf Android werden Chrome Custom Tabs verwendet, auf iOS SFSafariViewController.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.open({} as OpenOptions);clearCookies
Abschnitt mit dem Titel “clearCookies”Cookies der URL löschen
Wenn id weggelassen wird, gilt dies für alle geöffneten WebViews.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearCookies({} as ClearCookieOptions);clearAllCookies
Abschnitt mit dem Titel “clearAllCookies”Alle Cookies löschen
Wenn id weggelassen wird, gilt dies für alle geöffneten WebViews.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearAllCookies();clearCache
Abschnitt mit dem Titel “clearCache”Cache leeren
Wenn id weggelassen wird, gilt dies für alle geöffneten WebViews.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearCache();clearAllBrowsingData
Abschnitt „clearAllBrowsingData“Löscht alle Browserdaten aus dem Standard-Store und geöffneten verwalteten WebViews, einschließlich Cookies, Cache, Local Storage, Session Storage, IndexedDB, Formulardaten und HTTP-Auth-Daten, sofern die Plattform dies bereitstellt.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearAllBrowsingData();getCookies
Abschnitt „getCookies“Ruft Cookies für eine bestimmte URL ab.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.getCookies({} as GetCookieOptions);close
Abschnitt „close“Schließt die WebView.
Wenn id weggelassen wird, wird die aktive WebView geschlossen.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.close();hide
Abschnitt „hide“Blendet die WebView aus, ohne sie zu schließen.
Nutze show(), um sie wieder anzuzeigen.
Wenn id weggelassen wird, wird die aktive Webview verwendet.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.hide();Zeigt eine zuvor ausgeblendete WebView an.
Wann id weggelassen wird, wird die aktive Webview verwendet.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.show();sendToBack
Abschnitt mit dem Titel „sendToBack“Verschiebt den nativen Browser hinter die Capacitor Host-WebView. Verwenden Sie dies, wenn Ihre Ionic-UI über einer aktiven Browserseite erscheinen soll.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.sendToBack({ id: 'webview-id', transparentBackground: true });bringToFront
Abschnitt mit dem Titel „bringToFront“Bringt einen Browser, der hinter der Host-WebView lag, wieder nach vorne. Wenn id weggelassen wird, wird die aktive Webview verwendet.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.bringToFront({ id: 'webview-id' });dispatchInputEvent
Abschnitt mit dem Titel „dispatchInputEvent“Sendet ein Klick-, Touch- oder Scroll-Event an einen verwalteten Browser. Die Koordinaten sind relativ zum Browser-Viewport in CSS-Pixeln.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.dispatchInputEvent({ id: 'webview-id', type: 'click', x: 160, y: 420,});openWebView
Abschnitt mit dem Titel „openWebView“Öffnet eine URL in einem neuen Webview mit Toolbars und erweiterten Funktionen wie Kamera- und Dateizugriff, Event-Listening, JavaScript-Injection, bidirektionaler Kommunikation usw.
JavaScript-Schnittstelle: Wenn Sie eine WebView mit dieser Methode öffnen, wird automatisch eine JavaScript-Schnittstelle injiziert, die Folgendes bereitstellt:
window.mobileApp.close(): Schließt die WebView aus JavaScript herauswindow.mobileApp.postMessage({detail: {message: "myMessage"}}): Sendet eine Nachricht von der WebView an die App; das Detail-Objekt ist die Daten, die Sie an die WebView senden möchtenwindow.mobileApp.takeScreenshot()wennallowScreenshotsFromWebPagewahr ist
Promise timing differs by platform when isPresentAfterPageLoad verwendet wird.
Android löst auf { id } nachdem der Dialog bereit zur Steuerung ist, während iOS auf { id } unmittelbar nach dem Erstellen des nativen Webviews auflöst.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.openWebView({} as OpenWebViewOptions);executeScript
Abschnitt mit dem Titel „executeScript“Fügt JavaScript code in das InAppBrowser-Fenster ein.
Wenn id weggelassen wird, wird in allen geöffneten Webviews ausgeführt.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.executeScript({} as { code: string; id?: string });postMessage
Abschnitt mit dem Titel „postMessage“Sendet ein Ereignis an den Webview (In-App-Browser). Im Webview-JavaScript lauschen Sie dafür mit window.addEventListener('messageFromNative', listenerFunc).
detail ist die Nutzlast, die an die Webview gesendet wird. Da sie die Capacitor-Brücke überquert, muss sie JSON-serialisierbar sein.
Wenn id wird weggelassen, sendet an alle offenen WebViews.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.postMessage({} as { detail: Record<string, any>; id?: string });takeScreenshot
Abschnitt „takeScreenshot“Erstellt einen PNG-Screenshot des aktuellen Webview-Viewports.
Wenn id weggelassen wird, wird die aktive Webview verwendet.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.takeScreenshot();setUrl
Abschnitt „setUrl“Setzt die URL der Webview.
Wenn id weggelassen wird, wird die aktive Webview verwendet.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setUrl({} as { url: string; id?: string });handleProxyRequest
Abschnitt „handleProxyRequest“Interne Methode, die von addProxyHandler() um eine Proxy-Entscheidung an die native Ebene zurückzusenden.
Leiten Sie die ursprüngliche phase beim Antworten auf ein Handbuch proxyRequest Listener.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.handleProxyRequest({} as { requestId: string; decision?: ProxyDecision | null; response?: ProxyResponse | null; webviewId?: string; phase?: 'outbound' | 'inbound'; });reload
Abschnitt „reload“Die aktuelle Webseite neu laden.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.reload();updateDimensions
Abschnitt mit dem Titel „updateDimensions“Aktualisiert die Dimensionen des Webviews.
Ermöglicht die Änderung der Größe und Position des Webviews zur Laufzeit.
Wenn id weggelassen wird, wird die aktive Webview verwendet.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.updateDimensions({} as DimensionOptions & { id?: string });setEnabledSafeTopMargin
Abschnitt mit dem Titel „setEnabledSafeTopMargin“Setzt den aktivierten oberen sicheren Rand des Webviews zur Laufzeit.
Wenn id wird weggelassen, richtet sich an den aktiven WebView.
Im Web ist diese Methode ein No-Op und löst auf, ohne das Layout zu ändern.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setEnabledSafeTopMargin({} as { enabled: boolean; id?: string });setEnabledSafeBottomMargin
Abschnitt mit dem Titel „setEnabledSafeBottomMargin“Setzt den aktivierten unteren sicheren Rand des Webviews zur Laufzeit.
Wenn id wird weggelassen, richtet sich an den aktiven WebView.
Im Web ist diese Methode ein No-Op und löst auf, ohne das Layout zu ändern.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setEnabledSafeBottomMargin({} as { enabled: boolean; id?: string });openSecureWindow
Abschnitt mit dem Titel „openSecureWindow“Öffnet ein sicheres Fenster für die OAuth2-Authentifizierung. Für Web sollte die code in der umgeleiteten Seite vorhanden sein, um einen Broadcast-Channel zu verwenden, der die umgeleitete URL an die App sendet. Etwas wie:
<html><head></head><body><script> const searchParams = new URLSearchParams(location.search) if (searchParams.has("code")) { new BroadcastChannel("my-channel-name").postMessage(location.href); window.close(); }</script></body></html>