GoScrobble/web/node_modules/eslint-plugin-jsx-a11y/docs/rules/no-access-key.md

27 lines
752 B
Markdown
Raw Permalink Normal View History

2022-04-25 02:47:15 +00:00
# no-access-key
Enforce no accessKey prop on element. Access keys are HTML attributes that allow web developers to assign keyboard shortcuts to elements. Inconsistencies between keyboard shortcuts and keyboard commands used by screenreader and keyboard only users create accessibility complications so to avoid complications, access keys should not be used.
### References
1. [WebAIM](http://webaim.org/techniques/keyboard/accesskey#spec)
## Rule details
This rule takes no arguments.
### Succeed
```jsx
<div />
```
### Fail
```jsx
<div accessKey="h" />
```
## Accessibility guidelines
General best practice (reference resources)
### Resources
- [WebAIM, Keyboard Accessibility: Accesskey](http://webaim.org/techniques/keyboard/accesskey#spec)