# mousetrap

> Simple library for handling keyboard shortcuts

Latest version **1.6.5** (published 2020-01-23) · Apache-2.0 WITH LLVM-exception license · 0 weekly downloads

## Install

```sh
npm install mousetrap
pnpm add mousetrap
yarn add mousetrap
bun add mousetrap
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score; popular repo.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.5 |
| Published | 2020-01-23 |
| First published | 2012-08-01 |
| Weekly downloads | 0 |
| License | Apache-2.0 WITH LLVM-exception |
| TypeScript types | separate (@types/mousetrap) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 191.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11778 |
| Author | Craig Campbell |
| Maintainers | ccampbell, zeke |
| Keywords | keyboard, shortcuts, events |

## Links

- npm: https://www.npmjs.com/package/mousetrap
- Repository: https://github.com/ccampbell/mousetrap
- Homepage: https://github.com/ccampbell/mousetrap#readme
- Issues: https://github.com/ccampbell/mousetrap/issues
- npm.io page: https://npm.io/package/mousetrap

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 1.6.5 (latest) — 2020-01-23
- 1.6.4 — 2020-01-23
- 1.6.3 — 2019-03-04
- 1.6.2 — 2018-06-02
- 1.6.1 — 2017-04-02
- 1.6.0 — 2016-05-29
- 1.5.3 — 2015-07-02
- 1.5.2 — 2015-03-30
- 1.5.1 — 2015-03-30
- 1.4.6 — 2014-11-14
- 0.0.1 — 2012-08-01

## README

# Mousetrap
[![CDNJS](https://img.shields.io/cdnjs/v/mousetrap.svg)](https://cdnjs.com/libraries/mousetrap)

Mousetrap is a simple library for handling keyboard shortcuts in Javascript.

It is licensed under the Apache 2.0 license.

It is around **2kb** minified and gzipped and **4.5kb** minified, has no external dependencies, and has been tested in the following browsers:

- Internet Explorer 6+
- Safari
- Firefox
- Chrome

It has support for `keypress`, `keydown`, and `keyup` events on specific keys, keyboard combinations, or key sequences.

## Getting started

1. Include mousetrap on your page before the closing `</body>` tag

    ```html
    <script src="/path/to/mousetrap.min.js"></script>
    ```

    or install `mousetrap` from `npm` and require it

    ```js
    var Mousetrap = require('mousetrap');
    ```

2. Add some keyboard events to listen for

    ```html
    <script>
        // single keys
        Mousetrap.bind('4', function() { console.log('4'); });
        Mousetrap.bind("?", function() { console.log('show shortcuts!'); });
        Mousetrap.bind('esc', function() { console.log('escape'); }, 'keyup');

        // combinations
        Mousetrap.bind('command+shift+k', function() { console.log('command shift k'); });

        // map multiple combinations to the same callback
        Mousetrap.bind(['command+k', 'ctrl+k'], function() {
            console.log('command k or control k');

            // return false to prevent default browser behavior
            // and stop event from bubbling
            return false;
        });

        // gmail style sequences
        Mousetrap.bind('g i', function() { console.log('go to inbox'); });
        Mousetrap.bind('* a', function() { console.log('select all'); });

        // konami code!
        Mousetrap.bind('up up down down left right left right b a enter', function() {
            console.log('konami code');
        });
    </script>
    ```

## Why Mousetrap?

There are a number of other similar libraries out there so what makes this one different?

- There are no external dependencies, no framework is required
- You are not limited to `keydown` events (You can specify `keypress`, `keydown`, or `keyup` or let Mousetrap choose for you).
- You can bind key events directly to special keys such as `?` or `*` without having to specify `shift+/` or `shift+8` which are not consistent across all keyboards
- It works with international keyboard layouts
- You can bind Gmail like key sequences in addition to regular keys and key combinations
- You can programatically trigger key events with the `trigger()` method
- It works with the numeric keypad on your keyboard
- The code is well documented/commented

## Tests

Unit tests are run with <a href="https://mochajs.org/">mocha</a>.

### Running in browser

[View it online](http://rawgit.com/ccampbell/mousetrap/master/tests/mousetrap.html) to check your browser compatibility. You may also download the repo and open `tests/mousetrap.html` in your browser.

### Running with Node.js

1. Install development dependencies

    ```sh
    cd /path/to/repo
    npm install
    ```

3. Run tests

    ```sh
    npm test
    ```

## Documentation

Full documentation can be found at https://craig.is/killing/mice

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