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

Improve docs for common use cases #42

Open
PJK opened this issue Sep 22, 2017 · 0 comments
Open

Improve docs for common use cases #42

PJK opened this issue Sep 22, 2017 · 0 comments

Comments

@PJK
Copy link

PJK commented Sep 22, 2017

The docs don't describe how to use different keyboard events, which is necessary for overriding Tab/Shift+Tab navigation, probably one of the most common use cases for iron-a11y-keys.

Description

Tab/Shift+Tab navigation in screenreaders is triggered on keydown (as opposed to the default keypress). Capturing the different types of keyboard events is only documented in the grammar specs. Adding an example of how to specify and use this event could be rather helpful to future users.

Moreover, the docs could clarify that keyboard events that have a modifier key will be triggered even if the component only specifies the main key (e.g. tab will fire on shift+tab).

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