Per iniziare
Copia un prompt di configurazione con i passaggi di installazione e la guida markdown completa per questo 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.
Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsPoi usa il seguente prompt:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-inappbrowser` plugin in my project.Se preferisci la configurazione manuale, installa il plugin eseguendo questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:
npm install @capgo/capacitor-inappbrowsernpx cap syncImporta
Sezione intitolata “Import”import { InAppBrowser } from '@capgo/capacitor-inappbrowser';Quick start: checkout ospitato in una WebView gestita
Sezione intitolata “Quick start: checkout ospitato in una WebView gestita”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(); }});Usa open() invece, quando vuoi Safari View Controller o Chrome Custom Tabs senza incorporare un intero stack WebView nativo.
Scegli la modalità Browser
Sezione intitolata “Scegli la modalità Browser”Usa open() quando vuoi la superficie del browser della piattaforma: Chrome Custom Tabs su Android e SFSafariViewController su iOS. Usa openWebView() quando la tua app deve controllare il WebView nativo: dimensioni personalizzate, toolbar, messaggistica con l'app, iniezione JavaScript, download, proxy, popup, istanze nascoste o layering dell'interfaccia.
Casi d'uso comuni
Sezione intitolata “Casi d'uso comuni”Mostra la UI Ionic sopra una pagina browser live
Sezione intitolata “Mostra l'interfaccia Ionic sopra una pagina del browser live”Apri il WebView gestito dietro il WebView host di Capacitor con toBack. La tua interfaccia Ionic può quindi essere renderizzata sopra la pagina, mentre il contenuto web rimane caricato dietro di essa. Inoltra i gesti al browser con dispatchInputEvent() quando l'overlay deve interagire con la pagina.
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 });Rendi trasparente lo sfondo dell'app nelle aree in cui il browser deve essere visibile. Quando il browser è dietro l'app, i gesti nativi appartengono ancora al WebView di Capacitor a meno che non li inoltri esplicitamente.
Crea un browser a schermo parziale o un bottom sheet
Sezione intitolata “Crea un browser a schermo parziale o un bottom sheet”Imposta height, width, x, e y per mantenere visibile parte dell'app Capacitor attorno al browser nativo. Su Android e iOS, i tocchi fuori dal frame del browser passano al Capacitor WebView sottostante.
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,});Usalo per mini browser, pannelli di offerta, widget di supporto, bottom sheet basati su browser o qualsiasi flusso in cui i controlli nativi dell'app devono restare toccabili al di fuori del contenuto web.
Mantieni private le sessioni di Checkout, Auth o Support
Sezione intitolata “Mantieni private le sessioni di checkout, autenticazione o supporto”Imposta persistWebViewData: false per i WebView gestiti che dovrebbero evitare dati persistenti del sito web dove la piattaforma lo supporta. Chiama clearAllBrowsingData() dopo il logout, il cambio account, le sessioni di test o i flussi che devono svuotare lo store predefinito e i WebView gestiti aperti.
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/login', persistWebViewData: false,});
await InAppBrowser.clearAllBrowsingData();await InAppBrowser.close({ id });Su Android, i cookie usano il cookie store del WebView di sistema, quindi clearAllBrowsingData() è la fase di pulizia per cookie e altri dati condivisi del browser.
Mantieni pronte più istanze del browser
Sezione intitolata “Mantieni pronte più istanze del browser”Usa hidden, hide(), e show() per precaricare o preservare più WebView gestite senza tenerle tutte a schermo. Le WebView nascoste possono ancora ricevere executeScript(), postMessage(), setUrl(), e le chiamate di chiusura.
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 });Incorpora flussi avanzati di Web App
Sezione intitolata “Incorpora flussi avanzati di Web App”Combina le regole proxy, handleDownloads, openBlankTargetInWebView, hiddenPopupWindow, enableGooglePaySupport, postMessage(), e executeScript() per portali documentali, flussi di upload, pagine di pagamento, help desk e altre web app incorporate che richiedono un controllo nativo senza uscire dall'app.
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' },});Panoramica API
Sezione intitolata “Panoramica API”Torna indietro nella cronologia del WebView, se possibile
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.goBack();Apri l'URL in una nuova finestra a schermo intero; su Android usa le Chrome Custom Tabs, su iOS SFSafariViewController.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.open({} as OpenOptions);clearCookies
Sezione intitolata “clearCookies”Cancella i cookie dell'URL
Quando id se omesso, si applica a tutte le webview aperte.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearCookies({} as ClearCookieOptions);clearAllCookies
Sezione intitolata “clearAllCookies”Cancella tutti i cookie
Quando id se omesso, si applica a tutte le webview aperte.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearAllCookies();clearCache
Sezione intitolata “clearCache”Cancella la cache
Quando id se omesso, si applica a tutte le webview aperte.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearCache();clearAllBrowsingData
Sezione intitolata “clearAllBrowsingData”Cancella tutti i dati di navigazione dallo store predefinito e dalle WebView gestite aperte, inclusi cookie, cache, local storage, session storage, IndexedDB, dati dei form e dati di autenticazione HTTP, dove la piattaforma li espone.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearAllBrowsingData();getCookies
Sezione intitolata “getCookies”Recupera i cookie per un URL specifico.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.getCookies({} as GetCookieOptions);Chiudi la webview.
Se id viene omesso, chiude la webview attiva.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.close();Nascondi la webview senza chiuderla.
Usa show() per riportarla a schermo.
Se id viene omesso, punta alla webview attiva.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.hide();Mostra una webview precedentemente nascosta.
Quando id viene omesso, punta alla webview attiva.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.show();sendToBack
Sezione intitolata “sendToBack”Sposta il browser nativo dietro la WebView host di Capacitor. Usa questa funzione quando la tua interfaccia Ionic deve apparire sopra una pagina browser attiva.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.sendToBack({ id: 'webview-id', transparentBackground: true });bringToFront
Sezione intitolata “bringToFront”Riporta in primo piano un browser che si trovava dietro la WebView host. Quando id viene omesso, punta alla webview attiva.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.bringToFront({ id: 'webview-id' });dispatchInputEvent
Sezione intitolata “dispatchInputEvent”Invia un evento di click, touch o scroll a un browser gestito. Le coordinate sono relative al viewport del browser in pixel CSS.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.dispatchInputEvent({ id: 'webview-id', type: 'click', x: 160, y: 420,});openWebView
Sezione intitolata “openWebView”Apre un URL in una nuova webview con toolbar e funzionalità avanzate, come accesso alla fotocamera, ai file, ascolto di eventi, iniezione di javascript, comunicazione bidirezionale, ecc.
Interfaccia JavaScript: Quando apri un webview con questo metodo, viene iniettata automaticamente un'interfaccia JavaScript che fornisce:
window.mobileApp.close(): Chiude il webview da JavaScriptwindow.mobileApp.postMessage({detail: {message: "myMessage"}}): Invia un messaggio dal webview all'app; l'oggetto detail contiene i dati da inviare al webviewwindow.mobileApp.takeScreenshot()quandoallowScreenshotsFromWebPageè true
Promise timing differs by platform when isPresentAfterPageLoad viene usato.
Android risolve con { id } dopo che il dialog è pronto da controllare, mentre iOS risolve con { id } subito dopo aver creato la webview nativa.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.openWebView({} as OpenWebViewOptions);executeScript
Sezione intitolata “executeScript”Inietta JavaScript code nella finestra dell'InAppBrowser.
Quando id viene omesso, viene eseguito in tutte le webview aperte.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.executeScript({} as { code: string; id?: string });postMessage
Sezione intitolata “postMessage”Invia un evento alla webview (in-app browser). Nel JavaScript della webview, ascoltalo con window.addEventListener('messageFromNative', listenerFunc).
detail è il payload inviato alla webview. Poiché attraversa il bridge Capacitor, deve essere JSON-serializzabile.
Quando id viene omesso, fa broadcast a tutte le webview aperte.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.postMessage({} as { detail: Record<string, any>; id?: string });takeScreenshot
Sezione intitolata “takeScreenshot”Cattura la viewport corrente del webview come screenshot PNG.
Quando id viene omesso, punta alla webview attiva.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.takeScreenshot();Imposta l'URL del webview.
Quando id viene omesso, punta alla webview attiva.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setUrl({} as { url: string; id?: string });handleProxyRequest
Sezione intitolata “handleProxyRequest”Metodo interno utilizzato da addProxyHandler() per inviare una decisione proxy al nativo.
Inoltra l'originale phase quando rispondi a un proxyRequest listener manuale.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.handleProxyRequest({} as { requestId: string; decision?: ProxyDecision | null; response?: ProxyResponse | null; webviewId?: string; phase?: 'outbound' | 'inbound'; });Ricarica la pagina web corrente.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.reload();updateDimensions
Sezione intitolata “updateDimensions”Aggiorna le dimensioni della webview.
Consente di modificare le dimensioni e la posizione della webview a runtime.
Quando id viene omesso, punta alla webview attiva.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.updateDimensions({} as DimensionOptions & { id?: string });setEnabledSafeTopMargin
Sezione intitolata “setEnabledSafeTopMargin”Imposta il margine superiore sicuro abilitato della webview a runtime.
Quando id viene omesso, il target è il webview attivo.
Su Web, questo metodo è un no-op e si risolve senza modificare il layout.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setEnabledSafeTopMargin({} as { enabled: boolean; id?: string });setEnabledSafeBottomMargin
Sezione intitolata “setEnabledSafeBottomMargin”Imposta il margine inferiore sicuro abilitato della webview a runtime.
Quando id è omesso, il target è la webview attiva.
Su Web, questo metodo è un no-op e si risolve senza modificare il layout.
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setEnabledSafeBottomMargin({} as { enabled: boolean; id?: string });openSecureWindow
Sezione intitolata “openSecureWindow”Apre una finestra sicura per l'autenticazione OAuth2. Per web, dovresti avere code nella pagina di reindirizzamento per usare un broadcast channel per inviare l'url di reindirizzamento all'app Qualcosa come:
<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>