# shortcuts

> Super performant and feature rich shortcuts management library.

Latest version **3.0.1** (published 2023-07-02) · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2023-07-02 |
| First published | 2015-03-04 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 28.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 76 |
| Maintainers | fabiospampinato |
| Keywords | shortcuts, performant |

## Links

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

## Dependencies (1)

- [shosho](https://npm.io/package/shosho.md) ^1.4.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.0.1 (latest) — 2023-07-02
- 3.0.0 — 2023-06-28
- 2.0.3 — 2022-11-24
- 2.0.2 — 2022-11-24
- 2.0.1 — 2022-11-24
- 2.0.0 — 2022-11-10
- 1.8.1 — 2022-01-11
- 1.8.0 — 2021-05-01
- 1.7.0 — 2021-03-22
- 1.6.2 — 2020-12-21
- 1.6.1 — 2020-07-10
- 1.6.0 — 2020-07-10
- 1.5.0 — 2020-06-04
- 1.4.2 — 2020-05-23
- 1.4.1 — 2020-05-23
- … 24 more at https://npm.io/package/shortcuts/versions

## README

# Shortcuts

Super performant and feature rich shortcuts management library.

This library is just a thin wrapper over [`ShoSho`](https://github.com/fabiospampinato/shosho) that provides a VSCode-like interface for managing shortcuts. Definitely check out [`ShoSho`](https://github.com/fabiospampinato/shosho), which provides more features and it may offer a lower-level but maybe more convenient API for your use case.

## Install

```sh
npm install --save shortcuts
```

## Usage

The following interface is provided:

```ts
type Descriptor = {
  handler?: ( event?: Event ): boolean | void,
  shortcut: string
};

type Disposer = {
  (): void
};

type Options = {
  capture?: boolean,
  target?: Window | Document | HTMLElement | SVGElement | MathMLElement,
  shouldHandleEvent?: ( event: Event ) => boolean
};

class Shortcuts {
  constructor ( options: Options );
  get (): Descriptor[];
  add ( descriptor: Descriptor | Descriptor[] ): void;
  register ( descriptor: Descriptor | Descriptor[] ): Disposer;
  remove ( descriptor: Descriptor | Descriptor[] ): void;
  reset (): void;
  trigger ( shortcut: string ): boolean;
  start (): void;
  stop (): void;
}
```

This is how you'd use the library:

```ts
import {Shortcuts} from 'shortcuts';

// Let's create a new shortcuts manager instance

const shortcuts = new Shortcuts ({
  capture: true, // Handle events during the capturing phase
  target: document, // Listening for events on the document object
  shouldHandleEvent ( event ) {
    return true; // Handle all possible events
  }
});

// Let's register and unregister some shortcuts
// Handlers are filtered by shortcut and executed from bottom to top, stopping at the first handler that returns true

const onCtrlB = () => {};

shortcuts.add ([
  {
    shortcut: 'Ctrl+A',
    handler: () => {
      // Doing something...
      return true; // Returning true if we don't want other handlers for the same shortcut to be called later
    }
  },
  {
    shortcut: 'Ctrl+B',
    handler: onCtrlB
  },
  {
    shortcut: 'CmdOrCtrl+K Shift+B',
    handler: () => {
      // Doing something...
      return true; // Returning true if we don't want other handlers for the same shortcut to be called later
    }
  },
  {
    shortcut: '-Ctrl+A' // Removing all previously-registered handlers for "Ctrl+A"
  }
]);

shortcuts.remove ({ shortcut: 'Ctrl+B', handler: onCtrlB }); // Removing a specific handler bound to this shortcut
shortcuts.remove ({ shortcut: 'Ctrl+A' }); // Removing all handlers bound to this shortcut

// Let's actually start listening for shortcuts

shortcuts.start ();

// Let's stop listening for shortcuts

shortcuts.stop ();

// Let's dispose of all registered shortcuts

shortcuts.reset ();
```

## Thanks

- Thanks to the people at [Koding](https://github.com/koding) for providing me the `shortcuts` package name on NPM! If you're looking for the previous package published under that name you can find it [here](https://github.com/koding/shortcuts) (`v0.x`).

## License

MIT © Fabio Spampinato

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