Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vague documentation #44

Open
greena13 opened this issue Oct 15, 2017 · 0 comments
Open

Vague documentation #44

greena13 opened this issue Oct 15, 2017 · 0 comments

Comments

@greena13
Copy link

Hey, thanks for the great package. I have been looking around for something that will allow me to easily define keyboard shortcuts in React apps for a while.

Unfortunately, the documentation could be improved:

  • The installation instructions are concise and informative, but the documentation of how to use <Shortcuts> is not very clear, imho
  • The event propagation behaviour is unclear when multiple <Shortcuts> are used - especially when nested
  • The default behaviour as it relates to stopPropagation and isolate is unclear
  • None of the behaviour documented through the test suite is summarised on the project's readme
  • There is no troubleshooting information

I've taken notes while I've been using the package, read through the test suite and done some experiments so I am going to create a pull request that I am hoping will improve the points above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant