Improve documentation and demos - Githubissues

ayrton / react-key-handler

React component to handle keyboard events :key:

http://ayrton.be/react-key-handler

387 stars 29 forks source link

Improve documentation and demos #16

Closed ayrton closed 8 years ago

ayrton commented 8 years ago

The documentation and demos aren't as good as they could be, these things currently come to mind:

README:

[x] Split up examples by type: decorator, component, form components
[x] Include link to examples in README section per type
[x] Explain the difference between keyValue, keyCode & keyName
[x] Explain what the possible options are for keyEventName
[x] ~~Explain when to use which keyEventName~~ (different PR)

DEMOS:

[x] Split up per type
[x] ~~Don't use relative path to include the library, do:~~ (different PR)

import ReactKeyHandler from 'react-key-handler';