Guía
Cómo usar Android Kiosk en Capacitor
Uso de @capgo/capacitor-android-kiosk
Plugin Android Kiosk de Capacitor para controlar el modo kiosco y la funcionalidad del launcher. Este plugin es solo para Android. Para el modo kiosco en iOS, usa la función Guided Access del dispositivo.
Instalar
bun add @capgo/capacitor-android-kiosk
bunx cap sync
bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.
Importar
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
API de un vistazo
| Método | Descripción |
|---|---|
isInKioskMode |
Comprueba si la app se está ejecutando en modo kiosco. |
isSetAsLauncher |
Comprueba si la app está configurada como launcher del dispositivo (app de inicio). |
enterKioskMode |
Entra en modo kiosco, oculta la UI del sistema y bloquea los botones físicos. También inicia un servicio keep-alive en primer plano para que el sistema tenga menos probabilidades de cerrar la app. Para que funcione bien, la app debe estar configurada como launcher del dispositivo. |
exitKioskMode |
Sale del modo kiosco, restaura la UI del sistema y la funcionalidad de los botones físicos. También detiene el servicio keep-alive en primer plano iniciado en enterKioskMode(). |
setAsLauncher |
Abre los ajustes de la pantalla de inicio del dispositivo para que el usuario pueda establecer esta app como launcher. Esto es necesario para que el modo kiosco funcione por completo. |
setAllowedKeys |
Define qué teclas físicas pueden funcionar en modo kiosco. Por defecto, todas las teclas físicas están bloqueadas en modo kiosco. |
Ejemplos
isInKioskMode()
Comprueba si la app se está ejecutando en modo kiosco.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isInKioskMode } = await CapacitorAndroidKiosk.isInKioskMode();
console.log('Kiosk mode active:', isInKioskMode);
isSetAsLauncher()
Comprueba si la app está configurada como launcher del dispositivo (app de inicio).
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);
enterKioskMode()
Entra en modo kiosco, oculta la UI del sistema y bloquea los botones físicos. También inicia un servicio keep-alive en primer plano para que el sistema tenga menos probabilidades de cerrar la app. Para que funcione bien, la app debe estar configurada como launcher del dispositivo.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.enterKioskMode();
exitKioskMode()
Sale del modo kiosco, restaura la UI del sistema y la funcionalidad de los botones físicos. También detiene el servicio keep-alive en primer plano iniciado en enterKioskMode().
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');
setAsLauncher()
Abre los ajustes de la pantalla de inicio del dispositivo para que el usuario pueda establecer esta app como launcher. Esto es necesario para que el modo kiosco funcione por completo.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.setAsLauncher();
// User will be prompted to select this app as the home app
setAllowedKeys()
Define qué teclas físicas pueden funcionar en modo kiosco. Por defecto, todas las teclas físicas están bloqueadas en modo kiosco.
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
// Allow volume keys only
await CapacitorAndroidKiosk.setAllowedKeys({
volumeUp: true,
volumeDown: true,
back: false,
home: false,
recent: false
});
Referencia completa
Continúa desde Usando @capgo/capacitor-android-kiosk
Si estás usando Uso de @capgo/capacitor-android-kiosk para planificar las operaciones del dashboard y de API, conéctalo con @capgo/capacitor-android-kiosk para los detalles de implementación en @capgo/capacitor-android-kiosk, Primeros pasos para los detalles de implementación en Primeros pasos, Resumen de API para los detalles de implementación en API Overview, Introducción para los detalles de implementación en Introducción, y Claves de API para los detalles de implementación en API Keys.