Zum Hauptinhalt springen
@capgo/capacitor-android-kiosk Device-APIs Open Source

Android Kiosk-Modus Capacitor Plugin

Android-Geräte im Kiosk-Modus sperren – mit Launcher-Funktionalität und Hardware-Key-Steuerung

Installieren

bun add @capgo/capacitor-android-kiosk bunx cap sync
npm, pnpm oder yarn
  • npm install @capgo/capacitor-android-kiosk
  • pnpm add @capgo/capacitor-android-kiosk
  • yarn add @capgo/capacitor-android-kiosk

Anleitung

Android Kiosk in Capacitor verwenden

Auf dem Gerät testen

Lade die Capgo App herunter und scanne den QR code.

Vorschau-QR code für das Android-Kiosk-Plugin

Nutzung von @capgo/capacitor-android-kiosk

Capacitor Android-Kiosk-Plugin zur Steuerung des Kiosk-Modus und der Launcher-Funktionalität. Dieses Plugin ist nur für Android verfügbar. Für den Kiosk-Modus auf iOS die Funktion „Geführter Zugriff“ des Geräts verwenden.

Installieren

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

bunx cap sync kopiert den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.

Importieren

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

API auf einen Blick

Methode Beschreibung
isInKioskMode Prüft, ob die App gerade im Kiosk-Modus läuft.
isSetAsLauncher Prüft, ob die App als Standard-Launcher (Home-App) festgelegt ist.
enterKioskMode Aktiviert den Kiosk-Modus, blendet die System-UI aus und blockiert Hardware-Buttons. Startet außerdem einen Foreground-Keep-Alive-Service, damit die App seltener vom System beendet wird. Damit das effektiv funktioniert, muss die App als Standard-Launcher festgelegt sein.
exitKioskMode Beendet den Kiosk-Modus, stellt die normale System-UI und die Funktion der Hardware-Buttons wieder her. Stoppt außerdem den Foreground-Keep-Alive-Service, der in enterKioskMode() gestartet wurde.
setAsLauncher Öffnet die Startbildschirm-Einstellungen des Geräts, damit der Nutzer diese App als Launcher festlegen kann. Das ist für den vollständigen Kiosk-Modus erforderlich.
setAllowedKeys Legt fest, welche Hardware-Tasten im Kiosk-Modus funktionieren dürfen. Standardmäßig sind alle Hardware-Tasten im Kiosk-Modus gesperrt.

Beispiele

isInKioskMode()

Prüft, ob die App gerade im Kiosk-Modus läuft.

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

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

isSetAsLauncher()

Prüft, ob die App als Standard-Launcher (Home-App) festgelegt ist.

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

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

enterKioskMode()

Aktiviert den Kiosk-Modus, blendet die System-UI aus und blockiert Hardware-Buttons. Startet außerdem einen Foreground-Keep-Alive-Service, damit die App seltener vom System beendet wird. Damit das effektiv funktioniert, muss die App als Standard-Launcher festgelegt sein.

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

await CapacitorAndroidKiosk.enterKioskMode();

exitKioskMode()

Beendet den Kiosk-Modus, stellt die normale System-UI und die Funktion der Hardware-Buttons wieder her. Stoppt außerdem den Foreground-Keep-Alive-Service, der in enterKioskMode() gestartet wurde.

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

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

setAsLauncher()

Öffnet die Startbildschirm-Einstellungen des Geräts, damit der Nutzer diese App als Launcher festlegen kann. Das ist für den vollständigen Kiosk-Modus erforderlich.

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

await CapacitorAndroidKiosk.setAsLauncher();
// User will be prompted to select this app as the home app

setAllowedKeys()

Legt fest, welche Hardware-Tasten im Kiosk-Modus funktionieren dürfen. Standardmäßig sind alle Hardware-Tasten im Kiosk-Modus gesperrt.

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

// Allow volume keys only
await CapacitorAndroidKiosk.setAllowedKeys({
  volumeUp: true,
  volumeDown: true,
  back: false,
  home: false,
  recent: false
});

Vollständige Referenz

Weiter mit der Nutzung von @capgo/capacitor-android-kiosk

Wenn du es nutzt Nutzung von @capgo/capacitor-android-kiosk um Dashboard- und API-Operationen zu planen, verbinde es mit @capgo/capacitor-android-kiosk für die Implementierungsdetails in @capgo/capacitor-android-kiosk, Erste Schritte für die Implementierungsdetails in Erste Schritte, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung und API Schlüssel für die Implementierungsdetails in den API Keys.

FAQ

FAQ zum Android-Kiosk-Plugin

Wie installiere ich das Android Kiosk Plugin in einer Capacitor-App?

Führe "bun add @capgo/capacitor-android-kiosk" (oder "npm install @capgo/capacitor-android-kiosk") aus und starte anschließend "bunx cap sync", damit die iOS- und Android-Projekte die nativen code übernehmen. Importiere es in deinem App-code aus "@capgo/capacitor-android-kiosk".

Funktioniert @capgo/capacitor-android-kiosk mit React, Vue und Angular?

Ja. Android Kiosk ist ein Capacitor-Paket und funktioniert daher mit jedem Web-Framework, das in Capacitor läuft, einschließlich Ionic, React, Vue, Angular, Svelte und reinem JavaScript.

Welche Capacitor-Version unterstützt @capgo/capacitor-android-kiosk?

Capgo Plugins folgen der Major-Version von Capacitor: Nutze die Plugin-Major-Version, die zu deiner Capacitor Major-Version passt (z. B. Plugin v8 bei Capacitor 8). Die Kompatibilitätstabelle im GitHub README listet die gepflegten Versionen auf.

Ist @capgo/capacitor-android-kiosk kostenlos und Open Source?

Ja. Der Source-Code von code ist öffentlich auf GitHub unter https://github.com/Cap-go/capacitor-android-kiosk/ und das Paket lässt sich kostenlos über npm installieren. Bug-Reports und Pull Requests sind willkommen.

Kann ich code, das Android Kiosk verwendet, ohne App Store Review aktualisieren?

Die Installation oder ein Upgrade des Plugins ändert den nativen code, weshalb ein neuer Store-Build nötig ist. Danach können JavaScript-, HTML- und CSS-Änderungen, die das Plugin aufrufen, sofort per Capgo Live Updates ausgeliefert werden.

Android-Kiosk-Änderungen ausliefern, ohne auf das App-Review zu warten

Sobald das Plugin in deinem Store-Build ist, bringt Capgo mit Live-Updates deine JavaScript-, HTML- und CSS-Änderungen in Minuten zu den Nutzern.

Starte mit Capgo