@capgo/capacitor-inappbrowser

Panoramica

@capgo/capacitor-inappbrowser fornisce 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, utilizzare proxy e sovrapporre con l'interfaccia UI di Ionic.

Utilizzalo quando la pagina richiede più di una semplice finestra esterna del browser: flussi di autenticazione OAuth e di pagamento, porteali di supporto integrati, schermate di pagamento, chiamate video, porteali di documenti, app web interattive o qualsiasi flusso in cui il tuo app necessita di controlli nativi intorno al contenuto web in tempo reale.

Cambiato il nome del pacchetto.

Uso comune

• Mostra l'interfaccia UI di Ionic o Capacitor sopra una pagina del browser in tempo reale con toBack, sendToBack(), bringToFront(), transparentBackgroundEsegui partial-screen browsers, fogli di lavoro laterali e visualizzazioni web picture-in-picture con dispatchInputEvent().
• Esegui flussi di checkout, login, supporto o cambio account senza archiviazione del sito web persistente utilizzando width, height, x, yTieni aperte più istanze del browser con updateDimensions().
• Let users tap the Capacitor app outside a custom-size browser frame on Android and iOS.
• Embed applicazioni web avanzate che richiedono proxy di richiesta, caricamento di file, download, controllo popup, supporto Google Pay, gestione dei link e messaggi tra app e pagina. persistWebViewData: false Capacità di base clearAllBrowsingData().
• Esegui partial-screen browsers, fogli di lavoro laterali e visualizzazioni web picture-in-picture con hidden, hide()Esegui flussi di checkout, login, supporto o cambio account senza archiviazione del sito web persistente utilizzando show() Tieni aperte più istanze del browser con
• Mantieni lo stato della pagina. _blank Embed applicazioni web avanzate che richiedono proxy di richiesta, caricamento di file, download, controllo popup, supporto Google Pay, gestione dei link e messaggi tra app e pagina.

Capacità di base

• open - Apre una URL in Chrome Custom Tabs su Android o SFSafariViewController - su iOS.
• openWebView - Apre una vista web nativa gestita con toolbar personalizzata, dimensioni, navigazione nativa, messaggi, scripting, proxy, download, popup e controlli dati.
• sendToBack / bringToFront - Sposta una vista web gestita dietro o sopra la Capacitor vista web host.
• dispatchInputEvent - Inoltra eventi di click, touch e scroll a un browser che si trova dietro l'interfaccia UI dell'app nativa.
• updateDimensions - Modifica le dimensioni e la posizione della vista web gestita senza ricaricare la pagina.
• hide / show - Mantiene le viste web gestite caricate mentre si eliminano o si ripristinano la loro presentazione nativa.
• postMessage / executeScript - Collega l'app Capacitor con il JavaScript in esecuzione all'interno della pagina gestita.
• clearAllBrowsingData / persistWebViewData - Controlla la persistenza dei cookie, cache, storage, IndexedDB e sessioni.
• handleDownloads, regole di proxy e eventi popup - Supporta porte documentali, flussi di caricamento, pagine di pagamento e applicazioni web integrate.

Pubblica API

Metodo	Descrizione
goBack	Naviga indietro nella storia del WebView se possibile.
open	Apri url in una nuova finestra a schermo intero, su android utilizza le custom tabs di Chrome, su ios utilizza SFSafariViewController.
clearCookies	Cancella cookie di url Quando id è omesso, si applica a tutti i webview aperti.
clearAllCookies	Cancella tutti i cookie Quando id è omesso, si applica a tutti i webview aperti.
clearCache	Cancella cache Quando id è omesso, si applica a tutti i webview aperti.
clearAllBrowsingData	Cancella cookie, cache, storage locale, storage di sessione, IndexedDB e altri dati di navigazione dallo store di default e dai WebViews gestiti.
getCookies	Ottenere i cookie per una specifica URL.
close	Chiudi la vista web. Quando id è omesso, chiude la vista web attiva.
hide	Nascondi la vista web senza chiuderla. Utilizza show() per riportarla in superficie. Quando id è omesso, si riferisce alla vista web attiva.
show	Mostra una vista web precedentemente nascosta. Quando id è omesso, si riferisce alla vista web attiva.
sendToBack	Mette il browser nativo dietro la Capacitor host WebView per far apparire la UI dell'app sopra di esso.
bringToFront	Mette un browser che era dietro la host WebView nuovamente in primo piano.
dispatchInputEvent	Inoltra l'input di click, touch o scroll a un browser gestito; le coordinate sono relative alla finestra di visualizzazione del browser.
openWebView	Apri l'URL in una nuova vista web con barre degli strumenti e funzionalità avanzate, come l'accesso alla camera, all'accesso ai file, ascolta gli eventi, inietta JavaScript, comunicazione a due vie, ecc.
executeScript	Inietta JavaScript code nella finestra InAppBrowser. Quando id è omesso, esegue in tutti i webview aperti.
postMessage	Invia un evento al webview (browser in-app). Ascolta nella pagina con window.addEventListener('messageFromNative', listenerFunc). Il detail il payload deve essere JSON-serializzabile. Quando id è omesso, invia a tutti i webview aperti.
takeScreenshot	Cattura lo stato corrente del webview viewport come screenshot PNG. Quando id è omesso, si concentra sul webview attivo.
setUrl	Imposta l'URL del webview. Quando id è omesso, si concentra sul 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 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(...) nel documento, e mantieni il payload serializzabile in formato JSON.
addListener	Si attiva ogni volta che viene catturato uno screenshot dal plugin API, il pulsante di screenshot nativo o il ponte di JavaScript injectato.
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 questo con handleDownloads: true quando si apre il webview.
addListener	Si attiva quando il download nativo fallisce. Abilita questo con handleDownloads: true quando si apre il webview.
addListener	Si attiva ogni volta che una pagina apre una finestra di popup/nuova finestra. Utilizza l'id del popup restituito con executeScript, postMessage, show, hide, e close.
addListener	Ascolta le richieste delegate dal runtime nativo. Preferisci addProxyHandler() invece di chiamare direttamente questo.
addListener	Ascolta l'output del console JavaScript emesso dalla pagina gestita. Abilita questo con captureConsoleLogs: true quando si apre il webview.
handleProxyRequest	Metodo interno utilizzato da addProxyHandler() per inviare una decisione di proxy indietro al nativo. Inoltra l'originale phase quando si risponde a un ascoltatore manuale. proxyRequest Elimina tutti gli ascoltatori per questo plugin.
removeAllListeners	Ricarica la pagina web corrente.
reload	Aggiorna le dimensioni del webview. Consente di modificare le dimensioni e la posizione del webview in tempo di esecuzione. Quando
updateDimensions	when id è omesso, si riferisce al webview attivo.
setEnabledSafeTopMargin	Imposta il margine superiore sicuro abilitato del webview in esecuzione. Quando id è omesso, si riferisce al webview attivo. Su Web, questo metodo è un no-op e risolve senza modificare la disposizione.
setEnabledSafeBottomMargin	Imposta il margine inferiore sicuro abilitato del webview in esecuzione. Quando id è omesso, si riferisce al webview attivo. 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 per l'avvio per gli esempi completi di HTML, Info.plist e AndroidManifest.

Valori di Riferimento

Usa questi valori con le opzioni della barra degli strumenti quando si apre un browser in-app o WebView.

Tipi di Barra degli Strumenti

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

Fonte di Verità

Questa documentazione è sincronizzata da src/definitions.ts in capacitor-inappbrowser.

Continua da @capgo/capacitor-inappbrowser

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