keys/hooks

Hooks

Per-hook API reference for @diffgazer/keys.

Keyboard and focus hooks split into two groups. Standalone hooks work anywhere — they take a ref, return handlers or run effects, and need no setup. Provider-backed hooks register through KeyboardProvider so they share one key dispatcher and participate in the scope stack; wrap your app (or the relevant subtree) in a provider to use them.

Standalone hooks

No provider required. Install the package (npm install @diffgazer/keys), or copy a standalone hook from the hosted registry (npx shadcn add https://r.b4r7.dev/r/keys/navigation.json).

Hook	Use it for
`useNavigation`	Arrow-key movement, selection, and focus tracking across a role-based list or tab bar.
`useFocusTrap`	Keeping Tab and Shift+Tab focus inside a modal or overlay container.
`useFocusRestore`	Returning focus to where the user was after triggerless temporary UI closes.
`useScrollLock`	Freezing body or container scroll behind an overlay, with reference counting.

Provider-backed hooks

Require KeyboardProvider. Package-only, since dispatch goes through the shared registry.

tsx

import { KeyboardProvider } from "@diffgazer/keys";

function App() {
  return (
    <KeyboardProvider>
      <ApplicationRoutes />
    </KeyboardProvider>
  );
}

Hook	Use it for
`useKey`	Binding an individual shortcut, optionally scoped to a region or scope.
`useScope`	Letting a dialog or drawer shadow a page-level shortcut while it is open.
`useScopedNavigation`	Scope-aware list navigation that works without first clicking into the list.
`useActionRowNavigation`	Two-zone rows with content plus a strip of inline action buttons.
`useFocusZone`	Moving focus between regions of a layout via arrow keys or Tab.

Movement within one list — useNavigation (standalone, you attach onKeyDown) or useScopedNavigation (provider-backed, scope-aware, no onKeyDown).
Movement between regions of a layout — useFocusZone.
A row with inline actions — useActionRowNavigation.

See the navigation, scopes, and focus zones guides for end-to-end patterns.

Hooks

Standalone hooks

Provider-backed hooks

Choosing a navigation hook