# @types/react-key-handler

> TypeScript definitions for react-key-handler

Latest version **1.2.4** (published 2023-12-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/react-key-handler
pnpm add @types/react-key-handler
yarn add @types/react-key-handler
bun add @types/react-key-handler
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2023-12-05 |
| First published | 2021-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/react-key-handler
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-key-handler
- npm.io page: https://npm.io/package/@types/react-key-handler

## Dependencies (1)

- [@types/react](https://npm.io/package/@types/react.md) *

## Recent versions

- 1.2.4 (latest) — 2023-12-05
- 1.2.3 (ts4.5) — 2023-11-07
- 1.2.0 (ts3.7) — 2021-10-08
- 1.2.2 — 2023-10-18
- 1.2.1 — 2023-09-27

## README

# Installation
> `npm install --save @types/react-key-handler`

# Summary
This package contains type definitions for react-key-handler (https://github.com/ayrton/react-key-handler).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-key-handler.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-key-handler/index.d.ts)
````ts
import * as React from "react";

type _KEYDOWN = "keydown";
type _KEYPRESS = "keypress";
type _KEYUP = "keyup";

export type Matcher = (event: KeyboardEvent, ref: ReactKeyHandlerIntrinsicProps) => boolean;

interface ReactKeyHandlerIntrinsicProps {
    /**
     * Any given [KeyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key)
     */
    keyValue?: string | string[];

    /**
     *  Any given [KeyboardEvent.keyCode](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode)
     *  @deprecated Deprecated in favour of `code`
     */
    keyCode?: number | number[];

    /**
     *  Any given [KeyboardEvent.code](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code)
     */
    code?: string | string[];

    /**
     *  Keyboard event type to listen to.
     *  @default 'keyup'
     */
    keyEventName?: _KEYDOWN | _KEYPRESS | _KEYUP;
}

export interface ReactKeyHandlerProps extends ReactKeyHandlerIntrinsicProps {
    /**
     * Callback that is called when they key is handled
     * @param event The event object
     */
    onKeyHandle: (event: React.KeyboardEvent) => void;
}

export default function KeyHandler(props: ReactKeyHandlerProps): React.JSX.Element;

export function keyHandleDecorator(
    matcher?: Matcher,
): (props: ReactKeyHandlerProps) => (Component: React.JSX.Element) => (...args: any[]) => React.JSX.Element;

export function keyToggleHandler(
    props: ReactKeyHandlerIntrinsicProps,
): (Component: React.JSX.Element) => (...args: any[]) => React.JSX.Element;

export function keyHandler(
    props: ReactKeyHandlerIntrinsicProps,
): (Component: React.JSX.Element) => (...args: any[]) => React.JSX.Element;

export const KEYDOWN: _KEYDOWN;

export const KEYPRESS: _KEYPRESS;

export const KEYUP: _KEYUP;

// Shut off automatic exporting
export {};

````

### Additional Details
 * Last updated: Tue, 05 Dec 2023 16:38:07 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Pedro Queiroz](https://github.com/pmqueiroz).

---
_Source: https://npm.io/package/@types/react-key-handler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._