# keyboard-shortcut-listener-helper

> Utility library for listening to keyboard shortcuts.

Latest version **0.1.3** (published 2024-04-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install keyboard-shortcut-listener-helper
pnpm add keyboard-shortcut-listener-helper
yarn add keyboard-shortcut-listener-helper
bun add keyboard-shortcut-listener-helper
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2024-04-17 |
| First published | 2024-03-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Susanne Vasik |
| Maintainers | zyksusanne |
| Keywords | keyboard, shortcut, listener, helper |

## Links

- npm: https://www.npmjs.com/package/keyboard-shortcut-listener-helper
- Repository: https://github.com/susyquest/keyboard-shortcut-listener-helper
- Homepage: https://github.com/susyquest/keyboard-shortcut-listener-helper#readme
- Issues: https://github.com/susyquest/keyboard-shortcut-listener-helper/issues
- npm.io page: https://npm.io/package/keyboard-shortcut-listener-helper

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [eventemitter3](https://npm.io/package/eventemitter3.md) ^4.0.7

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2024-04-17
- 0.1.2 — 2024-03-20
- 0.1.1 — 2024-03-20
- 0.0.1 — 2024-03-15

## README

# keyboard-shortcut-listener-helper

A utility library for easily listening to complex keyboard shortcuts in web applications.

## Installation

Install `keyboard-shortcut-listener-helper` using npm:

```bash
npm install keyboard-shortcut-listener-helper
```

## Usage

To use this library, first import and instantiate `KeyboardShortcutListenerHelper`, then use `registerShortcut` to
listen for specific keyboard shortcuts.

```javascript
const KeyboardShortcutListenerHelper = require('keyboard-shortcut-listener-helper');
const listener = new KeyboardShortcutListenerHelper();

// Register a shortcut: Ctrl+Shift+A
listener.registerShortcut('ctrl+shift+a', () => {
  console.log('Shortcut Ctrl+Shift+A was pressed!');
});
```

## Dependencies

- lodash: A modern JavaScript utility library delivering modularity, performance & extras.
- eventemitter3: A high performance EventEmitter.

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