@accessible/use-keycode

---

useKeycode()

npm i @accessible/use-keycode

---

A React hook for handling specific keycodes with a callback on keyup

Quick Start

import useKeycode from '@accessible/use-keycode'

const Component = () => {
  // logs event when escape key is pressed
  const ref = useKeycode(27, console.log)
  return <div ref={ref} />
}

API

useKeycode(keyCode: number, callback: (event?: KeyboardEvent) => any)

Arguments

Argument	Type	Default	Required?	Description
keyCode	number	undefined	Yes	The keyCode you want to trigger the callback
callback	(event?: KeyboardEvent) => any	undefined	Yes	The callback you want to trigger when the keyCode matches the latest keyUp event

Returns MutableRefObject<any>

LICENSE

MIT