@capgo/capacitor-inappbrowser

Resumen

@capgo/capacitor-inappbrowser da a las aplicaciones Capacitor dos rutas de navegador: open() para la experiencia del navegador del sistema y openWebView() para un navegador nativo gestionado WebView que su aplicación puede dimensionar, ocultar, enviar mensajes, scriptear, reenviar 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 incorporados, pantallas de pago, llamadas de video, portales de documentos, aplicaciones web interactivas o cualquier flujo en el que su aplicación necesita controles nativos alrededor de contenido web en vivo.

El nombre del paquete cambió.

Uso común

• Presentar una interfaz de Ionic o Capacitor sobre una página de navegador en vivo con toBack, sendToBack(), bringToFront(), transparentBackground, y dispatchInputEvent().
• Crear navegadores de pantalla parcial, hojas inferiores y vistas de web en miniatura con width, height, x, y, y updateDimensions().
• Permitir a los usuarios tocar la aplicación Capacitor fuera de un marco de navegador personalizado de tamaño reducido 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().
• Mantener varias instancias de navegador cargadas con hidden, hide()y preservando el estado de la página. show() Insertar aplicaciones web avanzadas que necesitan proxy de solicitudes, subida de archivos, descarga de archivos, control de ventanas emergentes, soporte de Google Pay, manejo de enlaces, y mensajería de aplicación a página.
• Capacidades básicas _blank Sección titulada “Capacidades básicas”

- Abre una URL en Chrome Custom Tabs en Android o en iOS.

• open - Mueve un navegador gestionado detrás o encima del __CAPGO_KEEP_0__ navegador host. SFSafariViewController - Reenvía eventos de clic, toque y desplazamiento a un navegador que está detrás de la interfaz de usuario de la aplicación nativa.
• openWebView - Cambia el tamaño y la posición del navegador gestionado sin recargar la página.
• sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
• dispatchInputEvent - Abre un navegador nativo gestionado con herramienta de herramienta personalizada, tamaño, navegación nativa, mensajería, scripting, proxy, descargas, ventanas emergentes y controles de datos.
• updateDimensions - Mueve un navegador gestionado detrás o encima del __CAPGO_KEEP_0__ navegador host.
• hide / show - Mantiene cargados los navegadores web administrados 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 administrada.
• clearAllBrowsingData / persistWebViewData - Controla cookies, caché, almacenamiento, IndexedDB y persistencia de sesión.
• handleDownloads- Reglas de proxy y eventos de popup - Soporta puertas de enlace de documentos, flujos de carga, páginas de pago y aplicaciones web incorporadas.

Acceso público a API

Método	Descripción
goBack	Vuelve atrás en la historia del navegador web si es posible.
open	Abre la url en una ventana nueva en pantalla completa, en Android utiliza tabs personalizadas de Chrome, en iOS utiliza SFSafariViewController.
clearCookies	Borra cookies de la url Cuando id Si se omite, se aplica a todos los navegadores web abiertos.
clearAllCookies	Borrar todas las cookies Cuando id se omite, se aplica a todas las pestañas web abiertas.
clearCache	Borrar caché Cuando id se omite, se aplica a todas las pestañas web abiertas.
clearAllBrowsingData	Borra cookies, caché, almacenamiento local, almacenamiento de sesión, IndexedDB y otros datos de navegación del almacén predeterminado y de las pestañas web administradas.
getCookies	Obtener cookies para una URL específica.
close	Cerrar la pestaña web. Cuando id se omite, se cierra la pestaña web activa.
hide	Ocultar la pestaña web sin cerrarla. Utilice show() para traerla de nuevo. Cuando id se omite, se dirige a la pestaña web activa.
show	Mostrar una pestaña web previamente oculta. Cuando id se omite, se dirige a la pestaña web activa.
sendToBack	Mueve el navegador nativo detrás del Capacitor host WebView para que la interfaz de usuario de la aplicación pueda aparecer encima de él.
bringToFront	Mueve un navegador que estaba detrás del host WebView nuevamente a la parte delantera.
dispatchInputEvent	Envía click, toque o input de desplazamiento a un navegador gestionado; las coordenadas son relativas a la vista previa del navegador.
openWebView	Abre una URL en una nueva vista web con barras de herramientas y capacidades mejoradas, como acceso a la cámara, acceso a archivos, escucha eventos, inyecta JavaScript, comunicación bidireccional, etc.
executeScript	Inyecta JavaScript code en la ventana del navegador InAppBrowser. Cuando id se omite, se ejecuta en todas las vistas web abiertas.
postMessage	Envía un evento a la vista web (navegador en la aplicación). Escucha en la página con window.addEventListener('messageFromNative', listenerFunc). El detail payload debe ser JSON-serializable. Cuando id se omite, se transmite a todas las vistas web abiertas.
takeScreenshot	Captura la vista previa actual de la vista web 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 se omite, se dirige a la vista web activa.
addListener	Escucha el cambio de URL, solo para openWebView.
addListener	Escucha buttonNearDoneClick; el payload contiene la vista web 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 un aviso, funciona con openWebView shareDisclaimer y closeModal.
addListener	Se dispara cuando la vista web envía un evento de vuelta a la aplicación. Utilice window.mobileApp.postMessage(...) en la página, y mantenga el payload JSON-serializable.
addListener	Se disparará cada vez que se capture una captura de pantalla desde el plugin API, el botón de captura de pantalla nativo 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. Active esto con handleDownloads: true al abrir la vista web.
addListener	Se disparará cuando el manejo de descargas nativas falla. Active esto con handleDownloads: true al abrir la vista web.
addListener	Se disparará cada vez que una página abra una ventana emergente/nueva. Utilice el id de ventana emergente devuelto con executeScript, postMessage, show, hide, y close.
addListener	Escuche las solicitudes delegadas por proxy por el runtime nativo. Prefiera addProxyHandler() en lugar de llamar a esto directamente.
addListener	Escuche la salida de la consola de JavaScript emitida por la página gestionada. Active esto con captureConsoleLogs: true al abrir la vista web.
handleProxyRequest	Método interno utilizado por addProxyHandler() para enviar una decisión de proxy hacia la nativa. Reenvíe el original phase cuando se responde a un manual proxyRequest escuchador.
removeAllListeners	Elimina todos los escuchadores para este plugin.
reload	Recarga la página web actual.
updateDimensions	Actualiza 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 id se omite, se dirige a la vista web activa.
setEnabledSafeTopMargin	Establece el margen superior seguro habilitado de la vista web en tiempo de ejecución. Cuando id se omite, se dirige a la vista web activa. En la web, este método es un no-op y resuelve sin cambiar la disposición.
setEnabledSafeBottomMargin	Establece el margen inferior seguro habilitado de la vista web en tiempo de ejecución. Cuando id se omite, se dirige a la vista web activa. En la web, este método es un no-op 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 un URI de redirección personalizado 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

Utilice estos valores con opciones de herramienta de barra de herramientas al abrir un navegador en la aplicación o WebView.

Tipos de Herramienta de Barra de Herramientas

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

Fuente de Verdad

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

Sigue 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 Capgo Directorio de Plugin para el flujo de trabajo del producto en el directorio de plugins Capgo Capacitor Plugins por Capgo para el detalle de implementación en Capacitor Plugins 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