useKeysPressed

sensors

test coverage

Last changed: 24 days ago

all currently pressed keyboard keys and their codes

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

Usage

const pressedKeys = useKeysPressed(ref);
// or
const { value, ref } = useKeysPressed();

Demo

source

Api

Parameters

Name	Type	Default	Note
target	HookTarget | Window	-	DOM element or ref to attach keyboard listeners to
options.enabled?	UseKeysPressedOptions	true	Enable or disable the event listeners

Returns

Array<{ key: string; code: string }>

Parameters

Name	Type	Default	Note
options?	UseKeysPressedOptions	-	- Optional configuration options

Returns

{ keys: Array<{ key: string; code: string }>; ref: StateRef<Target> }

Source

Source • Demo

Contributors

debabin

hywax

Gorilla Dev