useKeyPress

sensors

test coverage

Last changed: last month

Hook that listens for key press events

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

Usage

const isKeyPressed = useKeyPress('a', window);
// or
const { pressed, ref } = useKeyPress('a');

Demo

source

Api

Parameters

Name	Type	Default	Note
target?	HookTarget	window	The target to attach the event listeners to
key	UseKeyPressKey	-	The key or keys to listen for
callback?	(pressed: boolean, event: KeyboardEvent) => void	-	Callback function invoked when key is pressed

Returns

boolean

Parameters

Name	Type	Default	Note
key	UseKeyPressKey	-	The key or keys to listen for
callback?	(pressed: boolean, event: KeyboardEvent) => void	-	Callback function invoked when key is pressed

Returns

{ pressed: boolean; ref: StateRef<Target> }

Source

Source • Demo

Contributors

debabin

hywax

Gorilla Dev