@accessible/use-keycode
v4.0.2TypeScript
A React hook for handling specific keycodes with a callback on keydown
0/weekUpdated 3 years agoMITUnpacked: 28.5 KB
Published by Jared Lunde
npm install @accessible/use-keycode
useKeycode()
npm i @accessible/use-keycode
A React hook for handling specific key codes with a callback on keydown
Quick Start
``jsx harmony`
import {useKeycode, useKeycodes} from '@accessible/use-keycode'
// one keycode
const Component = () => {
// logs event when escape key is pressed
const ref = useKeycode(27, console.log)
return
}
// several keycodes
const Component = () => {
// logs event when escape or enter key is pressed
const ref = useKeycodes({27: console.log, 13: console.log})
return
}
API
$3
#### Arguments
| Argument | Type | Default | Required? | Description |
| -------- | -------------------------------- | ----------- | --------- | ---------------------------------------------------------------------------------------- |
| which | number | undefined | Yes | The event.which you want to trigger the callback |(event?: KeyboardEvent) => any
| callback | | undefined | Yes | The callback you want to trigger when the event.which matches the latest keyUp event |
#### Returns React.MutableRefObject
$3
#### Arguments
| Argument | Type | Default | Required? | Description |
| ---------- | ------------------------------------------------ | ----------- | --------- | ------------------------------------------------------------------------------------- |
| handlers | Record | undefined | Yes | An object with keys matching the event.which you want to trigger the callback value |
#### Returns React.MutableRefObject
LICENSE
MIT