@capgo/capacitor-inappbrowser

Resumen

@capgo/capacitor-inappbrowser proporciona a las aplicaciones Capacitor dos rutas de navegador: open() para la experiencia del navegador del sistema y openWebView() para un WebView nativo gestionado que su aplicación puede dimensionar, ocultar, enviar mensajes, ejecutar scripts, configurar proxy y superponer con la interfaz de usuario de Ionic.

Utilícelo cuando la página necesita más que un navegador externo simple: flujos de OAuth y de pago, portales de soporte integrados, pantallas de pago, llamadas de video, portales de documentos, aplicaciones web interactivas o cualquier flujo en el que su aplicación necesite controles nativos alrededor de contenido web en vivo.

El nombre del paquete ha cambiado.

Uso común

• Presente la interfaz de usuario de Ionic o Capacitor por encima de una página de navegador en vivo con toBack, sendToBack(), bringToFront(), transparentBackgroundy dispatchInputEvent().
• Construya navegadores de pantalla parcial, hojas de abajo y vistas de imagen en imagen con width, height, x, yy updateDimensions().
• Deje que los usuarios toquen la aplicación Capacitor fuera de un marco de navegador de tamaño personalizado en Android e iOS.
• Ejecutar flujos de pago, inicio de sesión, soporte o cambio de cuenta sin almacenamiento de sitio web persistente utilizando persistWebViewData: false y clearAllBrowsingData().
• Mantenga varias instancias de navegador cargadas con hidden, hide()y show() mientras se preserva el estado de la página.
• Integrar aplicaciones web avanzadas que necesitan proxy de solicitud, subida de archivos, descarga de archivos, control de popup, soporte de Google Pay, _blank gestión de enlaces y mensajería de aplicación a página.

Capacidades principales

• open - Abre una URL en Chrome Custom Tabs en Android o SFSafariViewController - en iOS.
• openWebView - Abre un navegador nativo gestionado con barra de herramientas personalizada, tamaño, navegación nativa, mensajería, scripting, proxy, descargas, ventanas emergentes y controles de datos.
• sendToBack / bringToFront - Mueve un navegador gestionado detrás o encima del Capacitor navegador WebView host.
• dispatchInputEvent - Reenvía eventos de clic, toque y desplazamiento a un navegador que se encuentra detrás de la interfaz de usuario nativa de la aplicación.
• updateDimensions - Cambia el tamaño y la posición del navegador gestionado sin recargar la página.
• hide / show - Mantiene cargados los navegadores Web gestionados mientras se eliminan o restauran su presentación nativa.
• postMessage / executeScript - Conecta la aplicación Capacitor con JavaScript que se ejecuta dentro de la página gestionada.
• clearAllBrowsingData / persistWebViewData - Controla la persistencia de cookies, caché, almacenamiento, IndexedDB y sesión - Reglas de proxy y eventos de ventanas emergentes - Soporte para portales de documentos, flujos de carga, páginas de pago y aplicaciones web incorporadas.
• handleDownloadsVersión pública __CAPGO_KEEP_0__

Public API

Método	Descripción
goBack	Navega hacia atrás en la historia del WebView si es posible.
open	Abre la url en una ventana nueva en pantalla completa, en android utiliza chrome custom tabs, en ios utiliza SFSafariViewController.
clearCookies	Elimina las cookies de la url Cuando id se omite, se aplica a todos los webviews abiertos.
clearAllCookies	Elimina todas las cookies Cuando id se omite, se aplica a todos los webviews abiertos.
clearCache	Elimina la caché Cuando id se omite, se aplica a todos los webviews abiertos.
clearAllBrowsingData	Elimina las cookies, caché, almacenamiento local, almacenamiento de sesión, IndexedDB y otros datos de navegación desde el almacén predeterminado y WebViews administrados.
getCookies	Obtenga cookies para una URL específica.
close	Cerrar la vista web. Cuando id se omite, cierra la vista web activa.
hide	Ocultar la vista web sin cerrarla. Utilice show() para traerla de vuelta. Cuando id se omite, se dirige a la vista web activa.
show	Mostrar una vista web previamente oculta. Cuando id se omite, se dirige a la vista web activa.
sendToBack	Mueve el navegador nativo detrás de la Capacitor host WebView para que la interfaz de usuario del aplicativo pueda aparecer encima de ella.
bringToFront	Mueve un navegador que estaba detrás de la WebView host de vuelta a la parte delantera.
dispatchInputEvent	Envía click, toque o evento de desplazamiento a un navegador gestionado; las coordenadas son relativas a la vista previa del navegador.
openWebView	Abra la url en una nueva vista web con barras de herramientas y capacidades mejoradas, como acceso a la cámara, acceso a archivos, escuchar eventos, inyectar javascript, comunicación bidireccional, etc.
executeScript	Inyecta JavaScript code en la ventana InAppBrowser. Cuando id se omite, se ejecuta en todas las vistas web abiertas.
postMessage	Envía un evento a la vista web (navegador en aplicación). Escucha en la página con window.addEventListener('messageFromNative', listenerFunc)La detail El payload debe ser serializable en JSON. Cuando id se omite, se emite a todas las vistas web abiertas.
takeScreenshot	Captura la vista web actual como una captura de pantalla PNG. Cuando id se omite, se dirige a la vista web activa.
setUrl	Establece la URL de la vista web. Cuando id Escucha el cambio de URL, solo para la vista web abierta.
addListener	Escucha
addListener	; el payload contiene la vista web buttonNearDoneClickse omite, se ejecuta en todas las vistas web abiertas. id.
addListener	Escucha solo el clic de cierre para openWebView.
addListener	Se disparará cuando el usuario haga clic en el botón de confirmación cuando se requiera el aviso de desglose, funciona con openWebView shareDisclaimer y closeModal.
addListener	Se dispara cuando el webview envía un evento de vuelta a la aplicación. Utiliza window.mobileApp.postMessage(...) en la página, y mantén el payload serializable en JSON.
addListener	Se disparará cada vez que se capture una captura de pantalla desde el plugin API, el botón de captura de pantalla nativa o el puente de JavaScript inyectado.
addListener	Se disparará cuando se cargue la página.
addListener	Se disparará cuando se produzca un error de carga de página.
addListener	Se disparará después de que el manejo de descargas nativas guarde un archivo localmente. Habilita esto con handleDownloads: true cuando se abre el webview.
addListener	Se disparará cuando el manejo de descargas nativas falla. Habilita esto con handleDownloads: true cuando se abre el webview.
addListener	Se disparará cada vez que una página abra una ventana emergente/nueva ventana. Utiliza el id de ventana emergente devuelto con executeScript, postMessage, show, hide, y close.
addListener	Escuchar solicitudes delegadas por el tiempo de ejecución nativo. Prefiere addProxyHandler() en lugar de llamar a esto directamente.
addListener	Escuchar la salida de consola de JavaScript emitida por la página administrada. Habilita esto con captureConsoleLogs: true cuando se abre la vista web.
handleProxyRequest	Método interno utilizado por addProxyHandler() para enviar una decisión de proxy de regreso a nativo. Reenvía el original phase al responder a un escuchador manual. proxyRequest Eliminar todos los escuchadores para este plugin.
removeAllListeners	Recargar la página web actual.
reload	Actualizar las dimensiones de la vista web. Permite cambiar el tamaño y la posición de la vista web en tiempo de ejecución. Cuando
updateDimensions	se actualiza la página web, se actualiza la vista web. id se omite, apunta a la vista activa del web.
setEnabledSafeTopMargin	Establece la margen superior segura habilitada del webview en tiempo de ejecución. Cuando id se omite, apunta a la vista activa del web. En la web, este método es una operación sin efecto y resuelve sin cambiar la disposición.
setEnabledSafeBottomMargin	Establece la margen inferior segura habilitada del webview en tiempo de ejecución. Cuando id se omite, apunta a la vista activa del web. En la web, este método es una operación sin efecto y resuelve sin cambiar la disposición.
openSecureWindow	Abre una ventana de OAuth2 segura. En la web, devuelve la URL redirigida a través de un BroadcastChannel; en móvil, registra una URI de redirección personalizada en la configuración de la aplicación. Consulte la guía de inicio rápido para obtener los ejemplos completos de HTML, Info.plist y AndroidManifest.

Valores de Referencia

Utiliza estos valores con opciones de herramienta al abrir un navegador en la aplicación o una vista del web.

Tipos de Herramienta

Valor	El usuario encontrará
activity	Barra de herramientas simple con controles de cierre y compartir.
compact	Barra de herramientas simple con un control de cierre.
navigation	Barra de navegación completa con controles de atrás y adelante.
blank	Sin barra de herramientas.

Fuente de Verdad

Esta referencia está sincronizada desde src/definitions.ts en capacitor-inappbrowser.

Siga adelante desde @capgo/capacitor-inappbrowser

Si estás utilizando @capgo/capacitor-inappbrowser para planificar el trabajo de plugin nativo, conecta con Usando @capgo/capacitor-inappbrowser para la capacidad nativa en Usando @capgo/capacitor-inappbrowser, Directorio de Plugins de Capgo para el flujo de trabajo del producto en Directorio de Plugins de Capgo, Plugins de Capacitor por Capgo para el detalle de implementación en Plugins de Capacitor por Capgo, Agregar o Actualizar Plugins para el detalle de implementación en Agregar o Actualizar Plugins, y Alternativas de Plugins de Ionic Enterprise para el flujo de trabajo del producto en Alternativas de Plugins de Ionic Enterprise.