-
Notifications
You must be signed in to change notification settings - Fork 60
create rule: github/a11y-no-visually-hidden-interactive-element #446
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
7ddd508
create rule: a11y-no-sr-only-class-when-focusable
kendallgassner 6b767a5
pass params
kendallgassner 7f76868
add docs and htmlPropName
kendallgassner 982b103
add test and add to react config
kendallgassner c916e88
update docs
kendallgassner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Ensures that interactive elements are not visually hidden (`github/a11y-no-sr-only-class-when-focusable`) | ||
|
|
||
| <!-- end auto-generated rule header --> | ||
|
|
||
| ## Rule Details | ||
|
|
||
| This rule guards against visually hiding interactive elements. If a sighted keyboard user navigates to an interactive element that is visually hidden they might become confused and assume that keyboard focus has been lost. | ||
|
|
||
| 👎 Examples of **incorrect** code for this rule: | ||
|
|
||
| ```jsx | ||
| <button className="sr-only">Submit</button> | ||
| ``` | ||
|
|
||
| ```jsx | ||
| <VisuallyHidden> | ||
| <button>Submit</button> | ||
| </VisuallyHidden> | ||
| ``` | ||
|
|
||
| ```jsx | ||
| <VisuallyHidden as="button">Submit</VisuallyHidden> | ||
| ``` | ||
|
|
||
| 👍 Examples of **correct** code for this rule: | ||
|
|
||
| ```jsx | ||
| <h2 className="sr-only">Welcome to GitHub</h2> | ||
| ``` | ||
|
|
||
| ```jsx | ||
| <VisuallyHidden> | ||
| <h2>Welcome to GitHub</h2> | ||
| </VisuallyHidden> | ||
| ``` | ||
|
|
||
| ```jsx | ||
| <VisuallyHidden as="h2">Welcome to GitHub</VisuallyHidden> | ||
| ``` | ||
|
|
||
| ## Version |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| const {getProp, getPropValue} = require('jsx-ast-utils') | ||
| const {getElementType} = require('../utils/get-element-type') | ||
|
|
||
| const INTERACTIVELEMENTS = ['a', 'button', 'summary', 'select', 'input', 'option', 'textarea'] | ||
|
|
||
| const checkIfInteractiveElement = (context, node) => { | ||
| const elementType = getElementType(context, node.openingElement) | ||
| const asProp = getPropValue(getProp(node.openingElement.attributes, 'as')) | ||
|
|
||
| for (const interactiveElement of INTERACTIVELEMENTS) { | ||
| if ((asProp ?? elementType) === interactiveElement) { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // if the node is VisuallyHidden or Sr-only recursively check if it has interactive children | ||
| const checkIfVisuallyHiddenAndInteractive = (context, node, isParentVisuallyHidden) => { | ||
| if (node.type === 'JSXElement') { | ||
| const className = getPropValue(getProp(node.openingElement.attributes, 'className')) | ||
| const isVisuallyHiddenElement = node.openingElement.name.name === 'VisuallyHidden' | ||
| const hasSROnlyClass = typeof className !== 'undefined' && className.includes('sr-only') | ||
| let isHidden = false | ||
|
|
||
| if (hasSROnlyClass || isVisuallyHiddenElement || !!isParentVisuallyHidden) { | ||
| if (checkIfInteractiveElement(context, node)) { | ||
| return true | ||
| } | ||
| isHidden = true | ||
| } | ||
| if (node.children && node.children.length > 0) { | ||
| return ( | ||
| typeof node.children?.find(child => | ||
| checkIfVisuallyHiddenAndInteractive(context, child, !!isParentVisuallyHidden || isHidden), | ||
| ) !== 'undefined' | ||
| ) | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| module.exports = { | ||
| meta: { | ||
| docs: { | ||
| description: 'Ensures that interactive elements are not visually hidden', | ||
| url: require('../url')(module), | ||
| }, | ||
| schema: [], | ||
| }, | ||
|
|
||
| create(context) { | ||
| return { | ||
| JSXElement: node => { | ||
| if (checkIfVisuallyHiddenAndInteractive(context, node, false)) { | ||
| context.report({ | ||
| node, | ||
| message: | ||
| 'Avoid adding the "sr-only" class to interactive elements. Visually hiding interactive elements can be confusing to sighted keyboard users as it appears their focus has been lost when they navigate to an sr-only element.', | ||
| }) | ||
| return | ||
| } | ||
| }, | ||
| } | ||
| }, | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| const rule = require('../lib/rules/a11y-no-sr-only-class-when-focusable') | ||
| const RuleTester = require('eslint').RuleTester | ||
|
|
||
| const ruleTester = new RuleTester({ | ||
| parserOptions: { | ||
| ecmaVersion: 'latest', | ||
| sourceType: 'module', | ||
| ecmaFeatures: { | ||
| jsx: true, | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| const errorMessage = | ||
| 'Avoid adding the "sr-only" class to interactive elements. Visually hiding interactive elements can be confusing to sighted keyboard users as it appears their focus has been lost when they navigate to an sr-only element.' | ||
|
|
||
| ruleTester.run('a11y-no-sr-only-class-when-focusable', rule, { | ||
| valid: [ | ||
| {code: '<VisuallyHidden as="h2">Submit</VisuallyHidden>'}, | ||
| {code: "<div className='sr-only'>Text</div>;"}, | ||
| {code: '<VisuallyHidden><div>Text</div></VisuallyHidden>'}, | ||
| {code: "<div className='other sr-only'>Text</div>;"}, | ||
| {code: "<span className='sr-only'>Text</span>;"}, | ||
| {code: "<button className='other'>Submit</button>"}, | ||
| {code: '<button>Submit</button>'}, | ||
| ], | ||
| invalid: [ | ||
| {code: '<VisuallyHidden as="button">Submit</VisuallyHidden>', errors: [{message: errorMessage}]}, | ||
| {code: '<VisuallyHidden><button>Submit</button></VisuallyHidden>', errors: [{message: errorMessage}]}, | ||
| { | ||
| code: '<VisuallyHidden><button class="sr-only">Submit</button></VisuallyHidden>', | ||
| errors: [{message: errorMessage}], | ||
| }, | ||
| {code: "<button className='sr-only'>Submit</button>", errors: [{message: errorMessage}]}, | ||
| {code: '<VisuallyHidden><div><button>Submit</button></div></VisuallyHidden>', errors: [{message: errorMessage}]}, | ||
| {code: "<a className='other sr-only' href='github.com'>GitHub</a>", errors: [{message: errorMessage}]}, | ||
| {code: "<summary className='sr-only'>Toggle open</summary>", errors: [{message: errorMessage}]}, | ||
| {code: "<textarea className='sr-only' />", errors: [{message: errorMessage}]}, | ||
| {code: "<select className='sr-only' />", errors: [{message: errorMessage}]}, | ||
| {code: "<input className='sr-only' />", errors: [{message: errorMessage}]}, | ||
| {code: "<a className='sr-only'>Read more</a>", errors: [{message: errorMessage}]}, | ||
| ], | ||
| }) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we wait to include this until: https://github.com/github/accessibility/issues/3868
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's fine! We could always override disable is temporarily in our projects.