@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, scriptare, proxyare e sovrapporre con l'interfaccia utente di Ionic.

Utilizzalo quando la pagina richiede più di un semplice browser esterno: 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 ha bisogno di controlli nativi intorno al contenuto web in tempo reale.

È cambiato il nome del pacchetto.

Usi comuni

• Mostra l'interfaccia di Ionic o Capacitor sopra una pagina di browser live con toBack, sendToBack(), bringToFront(), transparentBackground, e dispatchInputEvent().
• Costruisci browser a schermo parziale, schede in fondo e visualizzazioni web in miniatura con width, height, x, y, e updateDimensions().
• Consenti agli utenti di toccare l'app Capacitor fuori da un frame di browser personalizzato su Android e iOS.
• Esegui flussi di checkout, login, supporto o account-switching senza archiviazione persistente del sito web utilizzando persistWebViewData: false , e clearAllBrowsingData().
• Conserva più istanze di browser caricate con hidden, hide()e preservando lo stato della pagina. show() mentre preservando lo stato della pagina.
• Integra applicazioni web avanzate che richiedono la proxying delle richieste, gli upload dei file, i download, il controllo delle finestre popup, il supporto di Google Pay, _blank il trattamento dei collegamenti e la comunicazione app-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 dei dati.
• sendToBack / bringToFront - Sposta una vista web gestita dietro o sopra la Capacitor vista web host.
• dispatchInputEvent - Inoltra gli eventi di click, touch e scroll a una vista web che si trova dietro l'interfaccia utente nativa dell'applicazione.
• updateDimensions - Modifica le dimensioni e la posizione della vista web gestita senza ricaricare la pagina.
• hide / show - Mantiene caricati i WebView gestiti mentre rimuove o ripristina la loro presentazione nativa.
• postMessage / executeScript - Collega l'app Capacitor con il JavaScript eseguito all'interno della pagina gestita.
• clearAllBrowsingData / persistWebViewData - Controlla cookie, cache, storage, IndexedDB e persistenza della sessione.
• handleDownloads- Regole di proxy e eventi di popup - Supporta documenti portal, flussi di caricamento, pagine di pagamento e applicazioni web integrate.

- Pubblico API

Metodo	Descrizione
goBack	Naviga indietro nella storia del WebView se possibile.
open	Apre l'URL in una nuova finestra a schermo intero, su Android utilizza le custom tabs di Chrome, su iOS utilizza SFSafariViewController.
clearCookies	Cancella i cookie dell'URL Quando id - Omissis, si applica a tutti i WebView aperti.
clearAllCookies	Elimina tutti i cookie Quando id Se omesso, si applica a tutte le finestre aperte.
clearCache	Elimina cache Quando id Se omesso, si applica a tutte le finestre aperte.
clearAllBrowsingData	Elimina i cookie, la cache, il storage locale, il storage di sessione, IndexedDB e altri dati di navigazione dallo store predefinito e dalle WebView gestite.
getCookies	Ottieni i cookie per una specifica URL.
close	Chiudi la finestra di visualizzazione. Quando id Se omesso, chiude la finestra di visualizzazione attiva.
hide	Nascondi la finestra di visualizzazione senza chiuderla. Utilizza show() per riportarla indietro. Quando id Se omesso, si applica alla finestra di visualizzazione attiva.
show	Mostra una finestra di visualizzazione precedentemente nascosta. Quando id Se omesso, si applica alla finestra di visualizzazione attiva.
sendToBack	Sposta il browser nativo dietro il Capacitor host WebView in modo che l'interfaccia utente dell'app possa apparire sopra di esso.
bringToFront	Rimette in primo piano un browser che era dietro il host WebView.
dispatchInputEvent	Inoltra l'input di click, touch o scroll a un browser gestito; le coordinate sono relative alla finestra del browser.
openWebView	Apri una nuova finestra web con strumenti di navigazione e funzionalità avanzate, come l'accesso alla camera, all'accesso ai file, l'ascolto degli eventi, l'iniezione di JavaScript, la comunicazione bidirezionale, ecc.
executeScript	Inserisce il JavaScript code nella finestra del browser InApp. Quando id è omesso, esegue in tutte le finestre web aperte.
postMessage	Invia un evento alla finestra del browser (browser in-app). Ascolta nella pagina con window.addEventListener('messageFromNative', listenerFunc)Il detail payload deve essere serializzato in JSON. Quando id è omesso, invia a tutte le finestre web aperte.
takeScreenshot	Cattura lo screenshot della finestra del browser attuale come immagine PNG. Quando id è omesso, si riferisce alla finestra del browser attiva.
setUrl	Imposta l'URL della vista web. Quando id è omesso, si riferisce alla vista web attiva.
addListener	Ascolta il cambiamento dell'URL, solo per openWebView.
addListener	Ascolta buttonNearDoneClick; il payload contiene la vista web id.
addListener	Ascolta solo il click di chiusura per openWebView.
addListener	Si attiva quando l'utente clicca sul pulsante di conferma quando è richiesta la dichiarazione, funziona con openWebView shareDisclaimer e closeModal.
addListener	Si attiva quando la vista web invia un evento di ritorno all'applicazione. Utilizza window.mobileApp.postMessage(...) in 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 injectato.
addListener	Si attiva quando la pagina viene caricata.
addListener	Si attiva quando si verifica un errore di caricamento della pagina.
addListener	Verrà attivato dopo che il download nativo salva un file localmente. Abilita questo con handleDownloads: true quando si apre la vista web.
addListener	Verrà attivato quando il download nativo fallisce. Abilita questo con handleDownloads: true quando si apre la vista web.
addListener	Verrà attivato ogni volta che una pagina apre una finestra popup o una nuova finestra. Utilizza l'ID popup restituito con executeScript, postMessage, show, hide, e close.
addListener	Ascolta le richieste delegate dal runtime nativo. Preferisci addProxyHandler() invece di chiamarlo direttamente.
addListener	Ascolta l'output della console JavaScript emesso dalla pagina gestita. Abilita questo con captureConsoleLogs: true quando si apre la vista web.
handleProxyRequest	Metodo interno utilizzato da addProxyHandler() per inviare una decisione proxy al nativo. Inoltra l'originale phase quando rispondi 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 le dimensioni e la posizione della finestra di visualizzazione web in esecuzione. id quando è 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 per l'avvio 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	Toolbar semplice con controlli di chiusura e condivisione.
compact	Toolbar semplice con un controllo di chiusura.
navigation	Toolbar di navigazione completa con controlli di indietro e avanti.
blank	Nessuna toolbar.

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 del plugin nativo, connettilo con Utilizzando @capgo/capacitor-inappbrowser per la capacità nativa in Utilizzando @capgo/capacitor-inappbrowser Capgo Directory dei Plugin per il flusso di lavoro del prodotto nella Capgo Directory dei Plugin Capacitor Plugin da Capgo per i dettagli di implementazione in Capacitor Plugin da Capgo Aggiungere o Aggiornare i Plugin per i dettagli di implementazione in Aggiungere o Aggiornare i Plugin, e Alternative Plugin di Enterprise Ionic per il flusso di lavoro del prodotto in Alternative Plugin di Enterprise Ionic.