Skip to main content

node-fullykiosk

TypeScript-friendly React Hooks for the Fully Kiosk Browser App. Zero dependencies. Type-safe. Production-ready.

Get Started

Start building with node-fullykiosk in minutes.

Installation

Install the package and configure your React project

Quickstart

Build your first Fully Kiosk app with React hooks

Key Features

TypeScript-First

Full TypeScript support with type definitions and IntelliSense

Zero Dependencies

Lightweight library with no external dependencies

React Hooks

Modern React hooks API for clean, composable code

Production Ready

Battle-tested in real-world kiosk deployments

Core Capabilities

Access the full Fully Kiosk Browser API through intuitive React hooks.

Device Information

Access device ID, serial numbers, IMEI, and Android ID

Screen Control

Control brightness, orientation, sleep mode, and rotation lock

Network Connectivity

Monitor WiFi, IP addresses, and network status

Hardware Integration

Integrate with battery, Bluetooth, NFC, and QR scanners

API Reference

Explore the complete API documentation.

Device Information

useAndroidId, useDeviceId, useDeviceName, useImei

Network

useHostname, useIpv4Address, useWifi, useMacAddress

Screen & Display

useScreenBrightness, useScreenSleep, useOrientation

Hardware

useBatteryLevel, useCharging, useBluetooth, useNFC

Input & Locale

useKeyboard, useCurrentLocale

QR Scanner

useQRScanner

Quick Example

import { useBatteryLevel, useWifi, useScreenBrightness } from 'fullykiosk';

function KioskApp() {
  const { batteryLevel } = useBatteryLevel();
  const { isConnected, ssid } = useWifi();
  const { brightness, setBrightness } = useScreenBrightness();

  return (
    <div>
      <p>Battery: {batteryLevel}%</p>
      <p>WiFi: {isConnected ? ssid : 'Disconnected'}</p>
      <input
        type="range"
        min="0"
        max="255"
        value={brightness}
        onChange={(e) => setBrightness(Number(e.target.value))}
      />
    </div>
  );
}
This library requires the Fully Kiosk Browser app running on Android. The hooks will return undefined values when not running in the Fully Kiosk environment.

Build docs developers (and LLMs) love