@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 utente di Ionic.

Usalo quando la pagina richiede più di un semplice browser esterno: flussi OAuth e di checkout, portali di supporto integrati, schermate di pagamento, chiamate video, portali di documenti, applicazioni web interattive o qualsiasi flusso in cui la tua app necessita di controlli nativi intorno a contenuti web in tempo reale.

Nome del pacchetto modificato.

Usi comuni

• Presenta l'interfaccia di Ionic o Capacitor sopra una pagina di browser in tempo reale con toBack, sendToBack(), bringToFront(), transparentBackground, e dispatchInputEvent().
• Crea 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 di dimensioni custom 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 show() mentre preserva lo stato della pagina.
• Incorpora applicazioni web avanzate che richiedono la proxying delle richieste, gli upload dei file, i download, il controllo dei popup, il supporto di Google Pay, il trattamento dei collegamenti e la comunicazione app-pagina. _blank Capacità di base

Sezione intitolata “Capacità di base”

• open - Apre una vista web nativa gestita con toolbar personalizzato, dimensioni, navigazione nativa, messaggi, script, proxy, download, popup e controlli dei dati. SFSafariViewController - Muove una vista web gestita dietro o sopra la __CAPGO_KEEP_0__ vista web host.
• openWebView - Inoltra gli eventi di click, touch e scroll a un browser che si trova dietro l'interfaccia utente nativa dell'app.
• sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
• dispatchInputEvent Sezione intitolata “Capacità di base”
• updateDimensions - Cambia la dimensione e la posizione della WebView gestita senza ricaricare la pagina.
• hide / show - Mantiene le WebView gestite caricate mentre rimuove o ripristina la loro presentazione nativa.
• postMessage / executeScript - Collega l'app Capacitor con il JavaScript in esecuzione all'interno della pagina gestita.
• clearAllBrowsingData / persistWebViewData - Controlla i cookie, il cache, lo storage, l'IndexedDB e la persistenza della sessione.
• handleDownloads- Regole di proxy e eventi di popup - Supporta i documenti portal, le flussi di caricamento, le pagine di pagamento e le app web integrate.

- Pubblica API

- Metodo	- Descrizione
goBack	- Naviga indietro nella storia della WebView se possibile.
open	- Apri l'URL in una nuova finestra a schermo intero, su Android utilizza le schede personalizzate di Chrome, su iOS utilizza SFSafariViewController.
clearCookies	- Cancella i cookie dell'URL Quando id è omesso, si applica a tutte le finestre web aperte.
clearAllCookies	Cancella tutti i cookie Quando id è omesso, si applica a tutte le finestre web aperte.
clearCache	Cancella cache Quando id è omesso, si applica a tutte le finestre web aperte.
clearAllBrowsingData	Cancella i cookie, la cache, lo storage locale, lo storage sessione, IndexedDB e altri dati di navigazione dallo store predefinito e dalle finestre Web gestite.
getCookies	Ottieni i cookie per una specifica URL.
close	Chiudi la finestra web. Quando id è omesso, chiude la finestra web attiva.
hide	Nascondi la finestra web senza chiuderla. Utilizza show() per riportarla in superficie. Quando id è omesso, si applica alla finestra web attiva.
show	Mostra una finestra web precedentemente nascosta. Quando id è omesso, si riferisce al webview attivo.
sendToBack	Sposta il browser nativo dietro al WebView host Capacitor in modo che l'interfaccia utente dell'app possa apparire sopra di esso.
bringToFront	Sposta un browser che era dietro al WebView host al 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 un nuovo webview con strumenti di navigazione e funzionalità avanzate, come l'accesso alla camera, all'accesso ai file, l'ascolto degli eventi, l'iniezione del codice JavaScript, la comunicazione bidirezionale, ecc.
executeScript	Inserisce il codice JavaScript code nella finestra del browser InApp. Quando id è omesso, viene eseguito 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, viene trasmesso a tutti i webview aperti.
takeScreenshot	Cattura lo stato corrente della finestra del webview come screenshot in formato PNG. Quando id è omesso, si riferisce al webview attivo.
setUrl	Imposta l'URL del webview. Quando id è omesso, si riferisce al webview attivo.
addListener	Ascolta il cambiamento di URL, solo per openWebView.
addListener	Ascolta il buttonNearDoneClick; il payload contiene il webview id.
addListener	Ascolta il click di chiusura solo 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 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 è caricata.
addListener	Sarà attivato quando si verifica un errore di caricamento della pagina.
addListener	Sarà attivato dopo che il download nativo ha salvato un file localmente. Abilita questo con handleDownloads: true quando si apre il webview.
addListener	Sarà attivato quando il download nativo fallisce. Abilita questo con handleDownloads: true quando si apre il webview.
addListener	Sarà attivato ogni volta che una pagina apre una finestra popup o una nuova finestra. Utilizza l'ID popup restituito con executeScript, postMessage, show, hidee 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 il webview.
handleProxyRequest	Metodo interno utilizzato da addProxyHandler() invia una decisione di proxy di ritorno al nativo. Inoltra l'originale phase quando si risponde a una richiesta manuale proxyRequest listener.
removeAllListeners	Elimina tutti i listener per questo plugin.
reload	Ricarica la pagina web corrente.
updateDimensions	Aggiorna le dimensioni della vista web. Consente di modificare la dimensione e la posizione della vista web in esecuzione. id se omesso, si riferisce alla vista web attiva.
setEnabledSafeTopMargin	Imposta il margine superiore sicuro abilitato della vista web in esecuzione. Se id se omesso, si riferisce alla vista web attiva. Su Web, questo metodo è un no-op e risolve senza modificare la disposizione.
setEnabledSafeBottomMargin	Imposta il margine inferiore sicuro abilitato della vista web in esecuzione. Se id se omesso, si riferisce alla vista web attiva. Su Web, questo metodo è un no-op e risolve senza modificare la disposizione.
openSecureWindow	Apri una finestra OAuth2 sicura. Su web, restituisce l'URL di reindirizzamento attraverso un BroadcastChannel; su mobile, registrare un URI di reindirizzamento personalizzato nella configurazione dell'app. Vedere la guida per l'avvio per l'intero HTML, Info.plist e AndroidManifest esempi.

Valori di Riferimento

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

Tipi di Barra degli Strumenti

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

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, Directory dei plugin Capgo per il flusso di lavoro del prodotto in Capgo Directory dei plugin Plugin Capacitor sviluppati da Capgo per la dettaglio di implementazione in Capacitor Plugin Capacitor sviluppati da Capgo Aggiunta o Aggiornamento dei Plugin per la dettaglio di implementazione in Aggiunta o Aggiornamento dei Plugin, e Alternative Plugin Enterprise Ionic per il flusso di lavoro del prodotto in Alternative Plugin Enterprise Ionic.