`keyup` listener

[silverwind]

Is your feature request related to a problem? Please describe.

I'd like to track the "down" state of the shift key, and for that a way to define a keyUp listener would be necessary. With keyboardjs I do:

let shiftDown = false;
keyboardjs.bind("shift", () => {shiftDown = true});
keyboardjs.bind("shift", null, () => {shiftDown = false});

Describe the solution you'd like

Some way to define for which event to listen, for example with an options argument:

bindKey("shift", () => {}, {event: "keydown"});
bindKey("shift", () => {}, {event: "keyup"});

[RobertWHurst]

Hi @silverwind. Indeed this is important functionality. It is actually already possible to do this. There is a section on this in the readme. The gist is that you can pass an object as a handler instead of a function. The object has three optional properties. onPressed is essentially keydown, onPressedWithRepeat is the same thing, but calls the handler repeatedly (just like the browser), and onReleased is essentially keyup.

Here is an example:

bindKey('shift', {
  onPressed: () => console.log('keydown'),
  onReleased: () => console.log('keyup'),
})

bindKeyCombo('shift > b', {
  onPressed: () => console.log('keydown'),
  onReleased: () => console.log('keyup'),
})

Does that solve you're problem?

[RobertWHurst]

Going to close for now, but we can reopen if need be.

[silverwind]

Yes, that should be suitable, I CTRL-F'ed for keyup in the README which gave no matches, sorry for not looking more closely.

[RobertWHurst]

No problem at all, glad to help. 😁