useKeyPress

React hook that returns true when the specified targetKey is pressed.

!version

Installation

``bash
npm install @react-typed-hooks/use-key-press
`

Usage

`tsx
import { useKeyPress } from "@react-typed-hooks/use-key-press";

const Demo = () => {
const isEscapePressed = useKeyPress({ targetKey: "Escape" });

return isEscapePressed ? "Yes" : "No";
};
`

API

$3

`ts
interface UseKeyPressOptions {
targetKey: KeyboardEvent["key"];
}
`

`ts
function useKeyPress(options: UseKeyPressOptions): boolean;
`

$3

targetKey: KeyboardEvent["key"]

A predefined key value (i.e, Escape, Enter, Backspace, etc) to watch the keydown and keyup` event on.