@capgo/capacitor-inappbrowser

Panoramica

@capgo/capacitor-inappbrowser dà agli app Capacitor due percorsi del browser: open() per l'esperienza del browser del sistema e openWebView() per un WebView nativo gestito che il tuo app può dimensionare, nascondere, inviare messaggi, scrivere script, proxy e sovrapporre con UI di Ionic.

Usalo quando la pagina richiede più di un semplice browser esterno: flussi di accesso OAuth e di checkout, porteali di supporto integrati, schermate di pagamento, chiamate video, porteali di documenti, app web interattive o qualsiasi flusso in cui il tuo app ha bisogno di controlli nativi intorno al contenuto web in tempo reale.

Il nome del pacchetto è stato modificato.

Casi d'uso comuni

• Presenta l'interfaccia di Ionic o Capacitor sopra una pagina di navigazione live del browser con toBack, sendToBack(), bringToFront(), transparentBackgrounde dispatchInputEvent().
• Crea browser a schermo parziale, schede in basso e visualizzazioni web in miniatura con width, height, x, ye updateDimensions().
• Lascia ai utenti che premere il pulsante Capacitor dell'app al di fuori di una finestra del browser personalizzata su Android e iOS.
• Esegui flussi di checkout, login, supporto o account-switching senza archiviazione persistente del sito web utilizzando persistWebViewData: false e clearAllBrowsingData().
• Mantieni più istanze di browser caricate con hidden, hide()e show() mantenendo lo stato della pagina.
• Embed applicazioni web avanzate che richiedono proxy di richiesta, upload di file, download, controllo popup, supporto a Google Pay, _blank gestione dei link e messaggistica app-per-pagina.

Capacità di base

• open - Apre una URL in Chrome Custom Tabs su Android o SFSafariViewController - Apre un WebView nativo gestito con toolbar personalizzata, dimensioni, navigazione nativa, messaggistica, scripting, proxy, download, popup e controlli dati.
• openWebView - Muove un browser gestito dietro o sopra il WebView host __CAPGO_KEEP_0__.
• sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
• dispatchInputEvent - Modifica le dimensioni e la posizione del WebView gestito senza ricaricare la pagina.
• updateDimensions - Mantiene i WebViews gestiti caricati mentre rimuove o ripristina la loro presentazione nativa.
• hide / show Core Capabilities
• postMessage / executeScript - Collega l'app Capacitor con JavaScript eseguito all'interno della pagina gestita.
• clearAllBrowsingData / persistWebViewData - Controlla cookie, cache, storage, IndexedDB e persistenza della sessione.
• handleDownloads- Supporta porte documentali, flussi di caricamento, pagine di pagamento e applicazioni web integrate.

Public API

Metodo	Descrizione
goBack	Ritorna indietro nella storia del WebView se possibile.
open	Apre l'URL in una nuova finestra a schermo intero, su Android utilizza le tab custom di Chrome, su iOS utilizza SFSafariViewController.
clearCookies	Cancella i cookie dell'URL Quando id se omesso, si applica a tutti i webview aperti.
clearAllCookies	Cancella tutti i cookie Quando id è omesso, si applica a tutte le webview aperte.
clearCache	Svuota cache Quando id è omesso, si applica a tutte le webview aperte.
clearAllBrowsingData	Svuota i cookie, cache, storage locale, storage di sessione, IndexedDB e altri dati di navigazione dallo store predefinito e dalle WebViews gestite.
getCookies	Ottieni i cookie per una specifica URL.
close	Chiudi la webview. Quando id è omesso, chiude la webview attiva.
hide	Nascondi la webview senza chiuderla. Utilizza show() per riportarla in superficie. Quando id è omesso, si mira alla webview attiva.
show	Mostra una webview precedentemente nascosta. Quando id è omesso, si mira alla webview attiva.
sendToBack	Mette in secondo piano il browser nativo dietro la Capacitor host WebView per far apparire la UI dell'app sopra di esso.
bringToFront	Rimuove un browser che era dietro la WebView host e lo riporta in primo piano.
dispatchInputEvent	Inoltra l'input di click, touch o scroll a un browser gestito; le coordinate sono relative alla finestra del browser.
openWebView	Apri l'URL in una nuova vista web con barre degli strumenti e funzionalità potenziate, come l'accesso alla camera, all'accesso ai file, l'ascolto degli eventi, l'iniezione del codice JavaScript, la comunicazione bidirezionale, ecc.
executeScript	Inietta il codice JavaScript code nella finestra del browser InApp. Quando id invocato, esegue in tutte le finestre web aperte.
postMessage	Invia un evento alla vista web (browser in-app). Ascolta nella pagina con window.addEventListener('messageFromNative', listenerFunc). Il detail payload deve essere JSON-serializzabile. Quando id invocato, invia a tutte le finestre web aperte.
takeScreenshot	Cattura lo screenshot della finestra del browser come immagine PNG. Quando id invocato, si riferisce alla finestra del browser attiva.
setUrl	Imposta l'URL della vista web. Quando id è omesso, si riferisce al webview attivo.
addListener	Ascolta per il cambio di URL, solo per openWebView.
addListener	Ascolta per buttonNearDoneClick; il payload contiene il webview id.
addListener	Ascolta solo per il click di chiusura per openWebView.
addListener	Verrà attivato quando l'utente clicca sul pulsante di conferma quando è richiesta la dichiarazione, funziona con openWebView shareDisclaimer e closeModal.
addListener	Si attiva quando il webview invia un evento di ritorno all'applicazione. Utilizza window.mobileApp.postMessage(...) nella pagina, e mantieni il payload JSON-serializzabile.
addListener	Si attiva ogni volta che viene catturato uno screenshot dal plugin API, il pulsante di screenshot nativo o il ponte di JavaScript iniettato.
addListener	Si attiva quando la pagina viene caricata.
addListener	Si attiva quando si verifica un errore di caricamento della pagina.
addListener	Si attiva dopo che il download nativo salva un file localmente. Abilita questa con handleDownloads: true When si apre la vista web.
addListener	Attiverà quando il download nativo fallisce. Abilita questo con handleDownloads: true When si apre la vista web.
addListener	Attiverà ogni volta che una pagina apre una finestra popup. Utilizza il ritornato id popup con executeScript, postMessage, show, hide, e close.
addListener	Ascolta le richieste delegate da runtime nativo. Preferisci addProxyHandler() al posto di chiamare questo direttamente.
addListener	Ascolta l'output della console JavaScript emesso dalla pagina gestita. Abilita questo con captureConsoleLogs: true When si apre la vista web.
handleProxyRequest	Metodo interno utilizzato da addProxyHandler() per inviare una decisione proxy indietro al nativo. Inoltra l'originale phase When si risponde a una richiesta manuale proxyRequest ascoltatore.
removeAllListeners	Elimina tutti gli ascoltatori per questo plugin.
reload	Ricarica la pagina web corrente.
updateDimensions	Aggiorna le dimensioni della finestra di visualizzazione web. Consente di modificare la dimensione e la posizione della finestra di visualizzazione web in esecuzione. Quando id è omesso, si riferisce alla finestra di visualizzazione web attiva.
setEnabledSafeTopMargin	Imposta il margine superiore sicuro abilitato della finestra di visualizzazione web in esecuzione. Quando id è omesso, si riferisce alla finestra di visualizzazione web attiva. Su Web, questo metodo è un no-op e risolve senza modificare la disposizione.
setEnabledSafeBottomMargin	Imposta il margine inferiore sicuro abilitato della finestra di visualizzazione web in esecuzione. Quando id è omesso, si riferisce alla finestra di visualizzazione web attiva. Su Web, questo metodo è un no-op e risolve senza modificare la disposizione.
openSecureWindow	Apre una finestra OAuth2 sicura. Su web, restituisce l'URL di reindirizzamento attraverso un BroadcastChannel; su mobile, registra un URI di reindirizzamento personalizzato nella configurazione dell'app. Vedi la guida di avvio rapido per gli esempi completi di HTML, Info.plist e AndroidManifest.

Valori di riferimento

Usa questi valori con le opzioni del toolbar quando si apre un browser in-app o una WebView.

Tipi di toolbar

Valore	L'utente troverà
activity	Barra dei comandi semplice con controlli di chiusura e condivisione.
compact	Barra dei comandi semplice con controllo di chiusura.
navigation	Barra dei comandi di navigazione completa con controlli di indietro e avanti.
blank	Nessuna barra dei comandi.

Fonte di Verità

Questa riferimento è sincronizzato da src/definitions.ts in capacitor-inappbrowser.

Continua da @capgo/capacitor-inappbrowser

Se stai utilizzando @capgo/capacitor-inappbrowser per pianificare il lavoro di plugin nativo, connettilo con Utilizzare @capgo/capacitor-inappbrowser per la capacità nativa in Utilizzare @capgo/capacitor-inappbrowser Directory dei plugin Capgo per il flusso di lavoro del prodotto in Directory dei plugin Capgo Plugin da Capacitor sviluppate da Capgo per i dettagli di implementazione in Plugin da Capacitor sviluppate da Capgo, Aggiunta o Aggiornamento di Plugin per i dettagli di implementazione in Aggiunta o Aggiornamento di Plugin, e Alternative per Plugin Enterprise di Ionic per il flusso di lavoro del prodotto in Alternative per Plugin Enterprise di Ionic.