imobs/keycap

Typescript Keypress Bindings for React

keycap's Issues

Fill out the README

Add a proper description, some examples, so on. Get some inspiration from similar projects.

Set up npm deployment through CI

The job in the config is there but it's not been tested and nothing has been pushed. It would be nice to have something out there to at least reserve the name.

Better handling of multiple decorators on the same class

If a class component has multiple decorators maybe it should be a little smarter about setting up the lifecycle methods once. This might require decoupling the options.

Convert keys in registerCallback options to parsed KeySet

Currently, the keys are being passed into registerCallback as an array of strings and are being stored as-is. These aren't easy to filter or match on and should be passed through parseKeys to get an array of KeySet values.

Should the user input keys be in the form of a comma separated string?

Currently, the expectation is that the keys be provided through the API as an array of strings for each possible combination. Other similar libraries instead take a comma-separated string that is then split for each of the combinations. Maybe it's worth seeing how that would look.

Filter callbacks in keydownListener

Right now in keydownListener it is iterating through everything in instanceMap which means that every registered callback is fired off. This needs to filter to only those that have a matching key.

Followup: Filtering all registered callbacks every time a keydown event happens is an O(n) operation and there might not be any callbacks that match, which is a whole lot of wasted work. The idea would be to first convert instanceMap to be a hash map where the KeySet (or something similar) is the key and the value is the list of registered callbacks. Then when a keydown event does occur we convert the KeyboardEvent to a matching KeySet value and then use that to get the list of callbacks in O(1) time.