# @gechiui/keyboard-shortcuts

> Handling keyboard shortcuts.

Latest version **3.1.1** (published 2022-03-17) · GPL-2.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @gechiui/keyboard-shortcuts
pnpm add @gechiui/keyboard-shortcuts
yarn add @gechiui/keyboard-shortcuts
bun add @gechiui/keyboard-shortcuts
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2022-03-17 |
| First published | 2022-03-17 |
| Weekly downloads | 0 |
| License | GPL-2.0-or-later |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=12 |
| Dependencies | 6 |
| Unpacked size | 114.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | The GeChiUI Contributors |
| Maintainers | gechiui |
| Keywords | gechiui, gutenberg, keycodes |

## Links

- npm: https://www.npmjs.com/package/@gechiui/keyboard-shortcuts
- Repository: https://github.com/GeChiUI/gutenberg
- Homepage: https://github.com/GeChiUI/gutenberg/tree/HEAD/packages/keyboard-shortcuts/README.md
- Issues: https://github.com/GeChiUI/gutenberg/issues
- npm.io page: https://npm.io/package/@gechiui/keyboard-shortcuts

## Dependencies (6)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [rememo](https://npm.io/package/rememo.md) ^3.0.0
- [@gechiui/data](https://npm.io/package/@gechiui/data.md) ^6.2.1
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.16.0
- [@gechiui/element](https://npm.io/package/@gechiui/element.md) ^4.1.1
- [@gechiui/keycodes](https://npm.io/package/@gechiui/keycodes.md) ^3.3.1

## Recent versions

- 3.1.1 (latest) — 2022-03-17
- 3.0.7 — 2022-03-17

## README

# Keyboard Shortcuts

Keyboard shortcuts is a generic package that allows registering and modifying shortcuts.

## Installation

Install the module

```bash
npm install @gechiui/keyboard-shortcuts --save
```

_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@gechiui/babel-preset-default`](https://github.com/GeChiUI/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._

## API

<!-- START TOKEN(Autogenerated API docs) -->

### ShortcutProvider

Handles callbacks added to context by `useShortcut`.

_Parameters_

-   _props_ `Object`: Props to pass to `div`.

_Returns_

-   `import('@gechiui/element').GCElement`: Component.

### store

Store definition for the keyboard shortcuts namespace.

_Related_

-   <https://github.com/GeChiUI/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore>

_Type_

-   `Object`

### useShortcut

Attach a keyboard shortcut handler.

_Parameters_

-   _name_ `string`: Shortcut name.
-   _callback_ `Function`: Shortcut callback.
-   _options_ `Object`: Shortcut options.
-   _options.isDisabled_ `boolean`: Whether to disable to shortut.

<!-- END TOKEN(Autogenerated API docs) -->

## Contributing to this package

This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [GeChiUI](https://make.gechiui.com/core/) as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/GeChiUI/gutenberg/tree/HEAD/CONTRIBUTING.md).

<br /><br /><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

---
_Source: https://npm.io/package/@gechiui/keyboard-shortcuts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._