Skip to content

Commit 8fa8687

Browse files
author
Ethan Cohen
committed
Update README
1 parent 963847c commit 8fa8687

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# eslint-plugin-jsx-a11y
22

3-
A static analysis linter of jsx components and their accessibility with screen readers.
3+
A static analysis linter of jsx and its accessibility to all users.
44

55
## Installation
66

@@ -43,7 +43,12 @@ Then configure the rules you want to use under the rules section.
4343

4444
## Supported Rules
4545

46-
* Fill in provided rules here
46+
- img-uses-alt: Enforce that img jsx elements use the alt attribute.
47+
- onClick-uses-role: Enforce that non-interactive, visible elements (such as div) that have click handlers use the role attribute.
48+
- mouseEvents-require-keyEvents: Enforce that onMouseOver/onMouseOut are accompanied by onFocus/onBlur for strictly keyboard users.
49+
- use-onblur-not-onchange: Enforce that onBlur is used instead of onChange.
50+
- no-access-key: Enforce that the accessKey prop is not used on any element to avoid complications with keyboard commands used by a screenreader.
51+
- use-label-for: Enforce that label elements have the htmlFor attribute
4752

4853

4954

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
"keywords": [
66
"eslint",
77
"eslintplugin",
8-
"eslint-plugin"
8+
"eslint-plugin",
9+
"a11y",
10+
"accessibility",
11+
"jsx"
912
],
1013
"author": "Ethan Cohen",
1114
"main": "lib/index.js",

0 commit comments

Comments
 (0)