react-easy-shortcuts v1.0.1

react-easy-shortcuts

An very easy to use, PubSub like, React library to listen to keyboard shortcuts in your components

Live example

Install

npm install --save react-easy-shortcuts

Usage

Subscribing to keyboard shortcuts

Any of your components can listen for keyboards shortcuts with one simple line:

import React, { Component } from 'react'

import Shortcuts from 'react-easy-shortcuts'

	tokens = [];
...
	this.tokens.push(Shortcuts.subscribe("ctrl+z", () => console.log("ctrl+z pressed ")));
...

The returned token is an String, in this example i am pushing to an array to facilitate subscribing more than one function, but you can also save the token directly to the variable.

The same function can also listen to more than one shortcut:

...
	this.tokens.push(Shortcuts.subscribe("ctrl+z", "ctrl+b", (s) => console.log("shortcut pressed: "+s)));
...

Any shortcut that is being listened has his default behaviour disabled automatically.

Have in mind that some shortcuts cannot be used because they're captured by the browser before reaching the application

For full reference on the shortcuts you can use, see the original library reference

Unsubscribing from keyboard shortcuts

When one component will not be used anymore, for example on it's componentWillUnmount, it has to unsubscribe from all the keyboard shortcuts it's listening, this is done by one line too:

...
	Shortcuts.unsubscribe(this.tokens);
...

The argument can be an array of tokens or just one single token, this function support both

When all the listeners of some shortcut are removed, the shortcut is automatically unbinded and recover it's default behaviour

License

MIT © IvoFritsch

Special thanks to jaywcjlove for his hotkeys library