Saltare al contenuto

@capgo/capacitor-inappbrowser

Navegatore in-app nativo per Capacitor con WebView gestiti, layer di interfaccia nativa, sessioni private, proxying, download, popup e messaggi dell'app

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

Usalo quando la pagina richiede più di un semplice browser esterno: flussi di autenticazione OAuth e di pagamento, 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.
  • Presentare l'interfaccia di Ionic o Capacitor sopra una pagina di browser in tempo reale con toBack, sendToBack(), bringToFront(), transparentBackground, e dispatchInputEvent().
  • Creare browser a schermo parziale, fogli di foglio e visualizzazioni web in immagine dentro immagine con width, height, x, y, e updateDimensions().
  • Consentire agli utenti di cliccare sull'app Capacitor fuori da un frame di browser personalizzato di dimensioni custom su Android e iOS.
  • Eseguire flussi di pagamento, login, supporto o account-switching senza archiviazione persistente del sito web utilizzando persistWebViewData: false , e clearAllBrowsingData().
  • Conserva più istanze del browser caricato 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 a Google Pay, il trattamento dei collegamenti e la comunicazione app-pagina. _blank Capacità di base

Sottosezione intitolata “Capacità di base”

- Apre una URL in Chrome Custom Tabs su Android o
  • open - Apre una vista web nativa gestita con toolbar personalizzata, dimensioni, navigazione nativa, messaggi, script, proxy, download, popup e controlli dei dati. SFSafariViewController - Sposta una vista web gestita dietro o sopra la __CAPGO_KEEP_0__ vista web host.
  • openWebView - Inoltra gli eventi di click, touch e scroll a una vista web che si trova dietro l'interfaccia utente nativa dell'applicazione.
  • sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
  • dispatchInputEvent - Inoltra gli eventi di click, touch e scroll a una vista web che si trova dietro l'interfaccia utente nativa dell'applicazione.
  • updateDimensions - Cambia la dimensione e la posizione della WebView gestita senza ricaricare la pagina.
  • hide / show - Mantiene le WebView gestite caricati 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 cookie, cache, storage, IndexedDB e persistenza della sessione.
  • handleDownloads- Regole di proxy, eventi popup, documenti portal, flussi di caricamento, pagine di pagamento e applicazioni web integrate.
- 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.
clearAllCookiesCancella tutti i cookie Quando id è omesso, si applica a tutte le finestre web aperte.
clearCacheCancella cache Quando id è omesso, si applica a tutte le finestre web aperte.
clearAllBrowsingDataCancella i cookie, la cache, il storage locale, il storage di sessione, l'IndexedDB e altri dati di navigazione dallo store predefinito e dalle finestre Web gestite.
getCookiesOttenere i cookie per una specifica URL.
closeChiudi la finestra web. Quando id è omesso, chiude la finestra web attiva.
hideNascondi la finestra web senza chiuderla. Utilizza show() per riportarla indietro. Quando id è omesso, si applica alla finestra web attiva.
showMostra una finestra web precedentemente nascosta. Quando id è omesso, mira la vista attiva del web.
sendToBackSposta il browser nativo dietro la Capacitor host WebView per far apparire l'interfaccia utente dell'app sopra di esso.
bringToFrontSposta un browser che era dietro la host WebView al primo piano.
dispatchInputEventInoltra l'input di click, touch o scroll a un browser gestito; le coordinate sono relative alla finestra del browser.
openWebViewApre l'URL in una nuova vista del web 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.
executeScriptInietta il codice JavaScript code nella finestra del browser InApp. Quando id è omesso, viene eseguito in tutte le viste del web aperte.
postMessageInoltra un evento alla vista del web (browser in-app). Ascolta nella pagina con window.addEventListener('messageFromNative', listenerFunc)il payload deve essere JSON-serializzato. Quando detail è omesso, invia a tutte le viste del web aperte. id Cattura lo stato corrente della vista del web come screenshot in formato PNG. Quando
takeScreenshot__CAPGO_KEEP_0__ è un placeholder e deve essere mantenuto inalterato. id è omesso, si riferisce alla vista attiva del web.
setUrlImposta l'URL della vista del web. Quando id è omesso, si riferisce alla vista attiva del web.
addListenerAscolta il cambiamento dell'URL, solo per openWebView.
addListenerAscolta il buttonNearDoneClick; il payload contiene la vista del web id.
addListenerAscolta il click di chiusura solo per openWebView.
addListenerSi attiva quando l'utente clicca sul pulsante di conferma quando è richiesta la dichiarazione, funziona con openWebView shareDisclaimer e closeModal.
addListenerSi attiva quando la vista del web invia un evento di ritorno all'applicazione. Utilizza window.mobileApp.postMessage(...) in pagina, e mantieni il payload JSON-serializzabile.
addListenerSi attiva ogni volta che viene catturato uno screenshot dal plugin API, il pulsante di screenshot nativo o il ponte di JavaScript iniettato.
addListenerSi attiva quando la pagina viene caricata.
addListenerSi attiverà quando si verifica un errore di caricamento della pagina.
addListenerSi attiverà dopo che il download nativo salva un file localmente. Abilita questo con handleDownloads: true quando si apre il webview.
addListenerSi attiverà quando il download nativo fallisce. Abilita questo con handleDownloads: true quando si apre il webview.
addListenerSi attiverà 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.
addListenerAscolta le richieste delegate dal runtime nativo. Preferisci addProxyHandler() al posto di chiamare questo direttamente.
addListenerAscolta l'output della console JavaScript emesso dalla pagina gestita. Abilita questo con captureConsoleLogs: true quando si apre il webview.
handleProxyRequestMetodo interno utilizzato da addProxyHandler() invia una decisione di proxy indietro al nativo. Inoltra l'originale phase quando si risponde a una richiesta manuale proxyRequest ascoltatore.
removeAllListenersElimina tutti gli ascoltatori per questo plugin.
reloadRicarica la pagina web corrente.
updateDimensionsAggiorna le dimensioni della finestra di visualizzazione web. Consente di modificare le dimensioni e la posizione della finestra di visualizzazione web in esecuzione. id se omesso, si riferisce alla finestra di visualizzazione web attiva.
setEnabledSafeTopMarginImposta il margine superiore sicuro abilitato della finestra di visualizzazione web in esecuzione. Se id se omesso, si riferisce alla finestra di visualizzazione web attiva. Su Web, questo metodo è un no-op e risolve senza modificare la disposizione.
setEnabledSafeBottomMarginImposta il margine inferiore sicuro abilitato della finestra di visualizzazione web in esecuzione. Se id se omesso, si riferisce alla finestra di visualizzazione web attiva. Su Web, questo metodo è un no-op e risolve senza modificare la disposizione.
openSecureWindowApri una finestra OAuth2 sicura. Su web, restituisce l'URL reindirizzato attraverso un BroadcastChannel; su mobile, registrare un URI di reindirizzamento personalizzato nella configurazione dell'app. Vedere la guida introduttiva per gli esempi completi di HTML, Info.plist e AndroidManifest.

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

ValoreL'utente troverà
activityBarra degli strumenti semplice con controlli di chiusura e condivisione.
compactBarra degli strumenti semplice con un controllo di chiusura.
navigationBarra degli strumenti di navigazione completa con controlli di indietro e avanti.
blankNessuna barra degli strumenti.

Questa riferimento è sincronizzato da src/definitions.ts in 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 Plugin Capgo per il workflow del prodotto in Capgo Directory Plugin Capacitor Plugin per Capgo per i dettagli di implementazione in Capacitor Plugin per Capgo Aggiunta o Aggiornamento dei Plugin per i dettagli di implementazione in Aggiunta o Aggiornamento dei Plugin, e Alternative Plugin Enterprise Ionic per il workflow del prodotto in Alternative Plugin Enterprise Ionic.