Make hotkeys events removable

[SylvainMarty]

Hi!

We just started to use this library in our VueJS project, the shortcut system works great!
But we have an important downfall with this library in our single page app, we must remove subscribed events when there are not necessary anymore.

For this, it will be very helpful to have a method destroy() to unsubscribe all the event listeners added by the library.
For now, we use the unbind() method but its not enough and the current behavior can lead to memory leaks.

We can contribute with a PR but we wanted to see if there were any cons to add this method to the library.

I'm available if there's any question. 👍

[jaywcjlove]

@SylvainMarty Oh! I haven't used Vue.js yet, you can try to solve the lead to memory leaks issue.

[bichotll]

@SylvainMarty Just create an array and keep there all the keyboard events ;)
You can then foreach the array and delete them without leaving anything behind.

[yakov116]

@jaywcjlove thanks for the amazing library

Any update on this?

[jaywcjlove]

@SylvainMarty It can be handled in the following way.

// define shortcuts with a scope
hotkeys('ctrl+o, ctrl+alt+enter', 'issues', function(){
  console.log('do something');
});
hotkeys('o, enter', 'files', function(){ 
  console.log('do something else');
});

// set the scope (only 'all' and 'issues' shortcuts will be honored)
hotkeys.setScope('issues'); // default scope is 'all'

[jaywcjlove]

@yakov116 I think it may not be necessary. Can be achieved through scope.

[yakov116]

@jaywcjlove can you give a bit explaining how scope works?

I read the readme and tried it in practice.
From what i understand is that you can only have one scope active at a time is that correct?

[jaywcjlove]

@yakov116 Yes, there is only one scope

[yakov116]

@jaywcjlove ok.
Side thing do you mind if i send in a pr to improve the docs?

[jaywcjlove]

@yakov116 Welcome to improve the documentation.

[RickFrom1987]

Thanks @jaywcjlove for the awesome lib!
Bump for this issue @SylvainMarty Thx!

[SylvainMarty]

@jaywcjlove Thank you for all the explanation about scopes !
Nevertheless, I don't think it will be enough to avoid event listener leakage with frameworks that use frontend routing.
@RickFrom1987 Thank you for the bump, I will definitively take some time this week to make a PR. 😉

[jaywcjlove]

@SylvainMarty 👍 Looking forward to your PR.