跳过主要内容
返回到插件
@capgo/capacitor-android-kiosk
教程
由 github.com/Cap-go

Android Kiosk

使用启动器功能和硬件键控制将Android设备锁定到kiosk模式

指南

Android Kiosk教程

使用@capgo/capacitor-android-kiosk

Capacitor Android Kiosk插件,用于控制kiosk模式和启动器功能。这是一个Android-only插件。要在iOS上使用kiosk模式,请使用设备的Guided Access功能。

安装

bun add @capgo/capacitor-android-kiosk
bunx cap sync

此插件暴露的内容

  • isInKioskMode - 检查应用程序是否当前正在运行在kiosk模式下。
  • isSetAsLauncher - 检查应用程序是否设置为设备启动器(主应用)。
  • enterKioskMode - 进入kiosk模式,隐藏系统UI并阻止硬件按钮。还启动了一个前台keep-alive服务,以便应用程序不太可能被系统杀死。应用程序必须设置为设备启动器,这样才能有效地工作。
  • exitKioskMode - 退出 kiosk 模式,恢复正常的系统 UI 和硬件按钮功能。同时停止前台 keep-alive 服务,服务在 enterKioskMode() 中启动。

示例用法

isInKioskMode

检查应用是否当前正在 kiosk 模式下运行。

import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';

const { isInKioskMode } = await CapacitorAndroidKiosk.isInKioskMode();
console.log('Kiosk mode active:', isInKioskMode);

isSetAsLauncher

检查应用是否设置为设备启动器(主应用)。

import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';

const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);

enterKioskMode

进入 kiosk 模式,隐藏系统 UI 并阻止硬件按钮。同时启动前台 keep-alive 服务,以便应用更不容易被系统杀死。应用必须设置为设备启动器,才能有效地工作。

import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode

退出 kiosk 模式,恢复正常的系统 UI 和硬件按钮功能。同时停止前台 keep-alive 服务,服务在 enterKioskMode() 中启动。

import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';

await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');

完整参考