Skip to content

useKeyboardNavigation

jsxhook

useKeyboardNavigation: arrow-key list navigation with wrap/clamp support

Installation

$ bunx termuijs add use-keyboard-navigation

Copies the source into src/components/use-keyboard-navigation/ and installs @termuijs/core, @termuijs/jsx.

Usage

ts
import { useKeyboardNavigation } from '@termuijs/jsx'
ts
const { value, set, reset } = useKeyboardNavigation({
  initial: undefined,
})

API Reference

useKeyboardNavigation

PropTypeDefaultDescription
initialT | undefinedInitial value
persistbooleanfalsePersist to storage
keystringStorage key
#hook#use-keyboard-navigation