使用 @capgo/capacitor-android-kiosk
Capacitor Android Kiosk 插件用于控制 Kiosk 模式和 Launcher 功能。此插件仅限 Android 使用。如需 iOS 的 Kiosk 模式，请使用设备的 Guided Access 功能。
安装
bun add @capgo/capacitor-android-kiosk
bunx cap sync
bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。
导入
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
API 概览
| 方法 | 描述 |
|---|---|
isInKioskMode |
检查应用当前是否正处于 Kiosk 模式运行。 |
isSetAsLauncher |
检查应用是否已被设置为设备启动器（Home 应用）。 |
enterKioskMode |
进入 Kiosk 模式，隐藏系统 UI 并禁用硬件按键。同时启动前台保活服务，降低应用被系统杀掉的概率。为确保效果，应用必须被设置为设备启动器。 |
exitKioskMode |
退出 Kiosk 模式，恢复正常的系统 UI 和硬件按键功能。同时停止由 enterKioskMode() 启动的前台保活服务。 |
setAsLauncher |
打开设备的桌面设置，允许用户将此应用设为启动器。这是实现完整 Kiosk 模式功能的必要步骤。 |
setAllowedKeys |
设置在 Kiosk 模式下允许使用的硬件按键。默认情况下，Kiosk 模式会禁用所有硬件按键。 |
示例
isInKioskMode()
检查应用当前是否正处于 Kiosk 模式运行。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isInKioskMode } = await CapacitorAndroidKiosk.isInKioskMode();
console.log('Kiosk mode active:', isInKioskMode);
isSetAsLauncher()
检查应用是否已被设置为设备启动器（Home 应用）。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
const { isLauncher } = await CapacitorAndroidKiosk.isSetAsLauncher();
console.log('Is launcher:', isLauncher);
enterKioskMode()
进入 Kiosk 模式，隐藏系统 UI 并禁用硬件按键。同时启动前台保活服务，降低应用被系统杀掉的概率。为确保效果，应用必须被设置为设备启动器。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.enterKioskMode();
exitKioskMode()
退出 Kiosk 模式，恢复正常的系统 UI 和硬件按键功能。同时停止由 enterKioskMode() 启动的前台保活服务。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.exitKioskMode();
console.log('Exited kiosk mode');
setAsLauncher()
打开设备的桌面设置，允许用户将此应用设为启动器。这是实现完整 Kiosk 模式功能的必要步骤。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
await CapacitorAndroidKiosk.setAsLauncher();
// User will be prompted to select this app as the home app
setAllowedKeys()
设置在 Kiosk 模式下允许使用的硬件按键。默认情况下，Kiosk 模式会禁用所有硬件按键。
import { CapacitorAndroidKiosk } from '@capgo/capacitor-android-kiosk';
// Allow volume keys only
await CapacitorAndroidKiosk.setAllowedKeys({
volumeUp: true,
volumeDown: true,
back: false,
home: false,
recent: false
});
完整参考
继续使用 @capgo/capacitor-android-kiosk
如果你正在使用 使用 @capgo/capacitor-android-kiosk 来规划 dashboard 和 API 操作，请将其连接至 @capgo/capacitor-android-kiosk 有关 @capgo/capacitor-android-kiosk 中的实现细节， 快速入门 有关入门指南中的实现细节， API 概览 关于 API 概览中的实现细节， 简介 关于简介中的实现细节，以及 API 密钥 关于 API 密钥中的实现细节。