# shortcut-string

> Returns the textual representation of a shortcut given a keyboard event in the browser

Latest version **1.1.0** (published 2018-04-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install shortcut-string
pnpm add shortcut-string
yarn add shortcut-string
bun add shortcut-string
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-04-08 |
| First published | 2016-03-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | jacwright |

## Links

- npm: https://www.npmjs.com/package/shortcut-string
- Repository: https://github.com/jacwright/shortcut-string
- Homepage: https://github.com/jacwright/shortcut-string#readme
- Issues: https://github.com/jacwright/shortcut-string/issues
- npm.io page: https://npm.io/package/shortcut-string

## Dependencies (1)

- [keyboardevent-key-polyfill](https://npm.io/package/keyboardevent-key-polyfill.md) ^1.0.2

## Recent versions

- 1.1.0 (latest) — 2018-04-08
- 1.0.1 — 2016-03-28
- 1.0.0 — 2016-03-25

## README

# shortcut-string

This module returns the textual representation of a shortcut given a keyboard event. Examples of shortcuts:
 * Cmd+L
 * Cmd+Shift+M
 * Ctrl+O
 * Backspace
 * T
 * Right
 * Shift+Down
 * Shift+F1
 * Ctrl++
 * Ctrl+Left

```js
var shortcutString = require('shortcut-string');

document.addEventListener('keydown', function(event) {
  console.log(shortcutString.fromEvent(event));
});
```

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