Repository files navigation

A library for listening to keyboard shortcuts and combos, such asCtrl + Z,Ctrl + Shift + Z

npm i keyboard-ts# oryarn add keyboard-ts

import{Key,Keyboard}from'keyboard-ts'consttarget=document.getElementById('target')constkeyboard=newKeyboard(target)// listen to Del + Esckeyboard.on([Key.Escape,Key.Delete],()=>{/* do something ... */})// listen to Spacekeyboard.on([Key.Space],event=>{// event is classic HTML eventevent.preventDefault()/* do something ... */})// listen to Ctrl+Zkeyboard.on([[Key.Ctrl,Key.Z]],()=>{/* do something ... */})// listen to Ctrl+Shift+Zkeyboard.on([[Key.Ctrl,Key.Shift,Key.Z]],()=>{/* do something ... */})// listen to Ctrl+Z or Ctrl+Ykeyboard.on([[Key.Ctrl,Key.Z],[Key.Ctrl,Key.Y]],()=>{/* do something ... */})// listen to Ctrl+Z+Xkeyboard.on([[Key.Ctrl,Key.Z,Key.X]],()=>{/* do something ... */})// remove all listenerskeyboard.clear()

newKeyboard(target:HTMLElement)

Instantiate new keyboard shortcut manager. This manager will listen to key combos pressed on thetarget HTML element.

keyboard.on(combo:Key[],(event:KeyboardEvent)=>void)keyboard.on(combos:Key[][],(event:KeyboardEvent)=>void)

Start listening to when acombo (combination of keyboard keys) is pressed at the same time.

The callback receives the keyboard event triggered by the last pressed key of the combo. (e.g. If Ctrl + Z, triggersCtrl press event and then Z press event, the callback will receive the Z press event.)

Instead of onecombo, and array ofcombos can be passed in. In that case the callback is triggered if any of thecombos is pressed.

keyboard.pause()

Temporarily pause listening to any keyboard combos. Can be reversed by callingkeyboard.unpause().

keyboard.unpause()

Start listening again to keyboard combos again afterkeyboard.pause() was called.

keyboard.clear()

Remove all listeners.

1. It is not possible to usewindow.alert() inside the callback.

import{Key,Keyboard}from'keyboard-ts'consttarget=document.getElementById('target')constkeyboard=newKeyboard(target)// Do NOT use alert() as a callback!keyboard.on([Key.Ctrl,Key.A],()=>{❌alert('stuff')// alert() erases the subsequent 'mouseup' event and this breaks the functionality// of the Keyboard class, because it has no way of knowing whether a key was released or not.})

2. Windows key and select key are not supported

• v2.0.0
  • Removed support for Windows key and select key
  • Added support for Macbook CMD key
• v1.2.5
  • Added Limitations to readme
• v1.2.4
  • Fix combos during pause. User can now press part of the combo before or during pause, and the rest after pause.
  • Fix no longer triggering combos when some extra keys are pressed, now combos get triggered only when exactly the combo keys are pressed and nothing else. (e.g. Ctrl + Z combo does not get triggered anymore when user presses Ctrl + Shift + Z)
  • Fixed listening to single comboskeyboard.on([ Key.Ctrl, Key.A ], () => {}) where callback was getting triggered when any of the keys from the combo was pressed
• v1.2.3
  • Added methods to listen to keyboard combos