useKeyboard

Subscribes to global keyboard events streamed from the Fluxlay desktop app. Useful for game-like wallpapers.

Every keystroke the user types anywhere on the desktop is delivered, regardless of which window has focus. Because text typed into other apps also flows to the wallpaper, treat this hook as if your wallpaper could be perceived as a keylogger and design accordingly.

Permission declaration is required

To use this hook the wallpaper must declare the keyboard permission in fluxlay.yaml. Without the declaration the backend rejects the subscription with HTTP 403 and no events are delivered.

schemaVersion: 1
name: My Wallpaper
slug: my-wallpaper
version: 1.0.0
permissions:
  - keyboard

See manifest for the full permissions reference.

Import

import { useKeyboard } from "@fluxlay/react";

Signature

function useKeyboard(handlers: KeyboardHandlers): void;
 
interface KeyboardHandlers {
  onKeyDown?: (event: KeyEvent) => void;
  onKeyUp?: (event: KeyEvent) => void;
}

Usage

import { useKeyboard } from "@fluxlay/react";
 
function Wallpaper() {
  useKeyboard({
    onKeyDown: event => {
      console.log("down", event.code, event.modifiers, event.repeat);
    },
    onKeyUp: event => {
      console.log("up", event.code);
    }
  });
  return <div />;
}

KeyEvent

KeyModifiers

Platform requirements

• macOS: the user must grant Fluxlay "Input Monitoring" permission (System Settings → Privacy & Security → Input Monitoring).
• Windows: the global hook may be flagged by some antivirus software. Key events targeting processes running at a higher integrity level (e.g. apps launched as Administrator) are not delivered, due to UIPI.