useKeyboard

sensors

test coverage

Last changed: 24 days ago

Hook that helps to listen for keyboard events

import { useKeyboard } from '@siberiacancode/reactuse';

Usage

useKeyboard(ref, { onKeyDown: (event) => console.log('key down'), onKeyUp: (event) => console.log('key up') });
// or
const ref = useKeyboard({ onKeyDown: (event) => console.log('key down'), onKeyUp: (event) => console.log('key up') });

Demo

source

Api

Parameters

Name	Type	Default	Note
target	HookTarget | Window	-	The target to attach the event listeners to
options?	UseKeyboardOptions	-	The keyboard event options

Returns

void

Parameters

Name	Type	Default	Note
options?	UseKeyboardOptions	-	The keyboard event options

Returns

{ ref: StateRef<Target> }

Source

Source • Demo

Contributors

debabin

hywax