create rule: github/a11y-no-visually-hidden-interactive-element #446
There are no files selected for viewing
This file contains 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 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,77 @@ | ||
| # Ensures that interactive elements are not visually hidden (`github/a11y-no-visually-hidden-interactive-element`) | ||
|
|
||
| <!-- 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. | ||
|
|
||
| Note: we are not guarding against visually hidden `input` elements at this time. Some visually hidden inputs might cause a false positive (e.g. some file inputs). | ||
|
|
||
| ### Why do we visually hide content? | ||
|
|
||
| Visually hiding content can be useful when you want to provide information specifically to screen reader users or other assitive technology users while keeping content hidden from sighted users. | ||
|
|
||
| Applying the following css will visually hide content while still making it accessible to screen reader users. | ||
|
|
||
| ```css | ||
| clip-path: inset(50%); | ||
| height: 1px; | ||
| overflow: hidden; | ||
| position: absolute; | ||
| white-space: nowrap; | ||
| width: 1px; | ||
| ``` | ||
|
|
||
| 👎 Examples of **incorrect** code for this rule: | ||
|
|
||
| ```jsx | ||
| <button className="visually-hidden">Submit</button> | ||
| ``` | ||
|
|
||
| ```jsx | ||
| <VisuallyHidden> | ||
| <button>Submit</button> | ||
| </VisuallyHidden> | ||
| ``` | ||
|
|
||
| ```jsx | ||
| <VisuallyHidden as="button">Submit</VisuallyHidden> | ||
| ``` | ||
|
|
||
| 👍 Examples of **correct** code for this rule: | ||
|
|
||
| ```jsx | ||
| <h2 className="visually-hidden">Welcome to GitHub</h2> | ||
| ``` | ||
|
|
||
| ```jsx | ||
| <VisuallyHidden> | ||
| <h2>Welcome to GitHub</h2> | ||
| </VisuallyHidden> | ||
| ``` | ||
|
|
||
| ```jsx | ||
| <VisuallyHidden as="h2">Welcome to GitHub</VisuallyHidden> | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| - className - A css className that visually hides content. Defaults to `sr-only`. | ||
| - componentName - A react component name that visually hides content. Defaults to `VisuallyHidden`. | ||
| - htmlPropName - A prop name used to replace the semantic element that is rendered. Defaults to `as`. | ||
|
|
||
| ```json | ||
| { | ||
| "a11y-no-visually-hidden-interactive-element": [ | ||
| "error", | ||
| { | ||
| "className": "visually-hidden", | ||
| "componentName": "VisuallyHidden", | ||
| "htmlPropName": "as" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ## Version | ||
This file contains 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 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,88 @@ | ||
| const {getProp, getPropValue} = require('jsx-ast-utils') | ||
| const {getElementType} = require('../utils/get-element-type') | ||
| const {generateObjSchema} = require('eslint-plugin-jsx-a11y/lib/util/schemas') | ||
|
|
||
| const defaultClassName = 'sr-only' | ||
|
There was a problem hiding this comment. considering making the default There was a problem hiding this comment. I prefer |
||
| const defaultcomponentName = 'VisuallyHidden' | ||
| const defaultHtmlPropName = 'as' | ||
|
|
||
| const schema = generateObjSchema({ | ||
| className: {type: 'string'}, | ||
| componentName: {type: 'string'}, | ||
| htmlPropName: {type: 'string'}, | ||
| }) | ||
|
|
||
| /** Note: we are not including input elements at this time | ||
| * because a visually hidden input field might cause a false positive. | ||
| * (e.g. fileUpload https://github.com/primer/react/pull/3492) | ||
| */ | ||
| const INTERACTIVELEMENTS = ['a', 'button', 'summary', 'select', 'option', 'textarea'] | ||
|
|
||
| const checkIfInteractiveElement = (context, htmlPropName, node) => { | ||
| const elementType = getElementType(context, node.openingElement) | ||
| const asProp = getPropValue(getProp(node.openingElement.attributes, htmlPropName)) | ||
|
|
||
| for (const interactiveElement of INTERACTIVELEMENTS) { | ||
| if ((asProp ?? elementType) === interactiveElement) { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // if the node is visually hidden recursively check if it has interactive children | ||
| const checkIfVisuallyHiddenAndInteractive = (context, options, node, isParentVisuallyHidden) => { | ||
| const {className, componentName, htmlPropName} = options | ||
| if (node.type === 'JSXElement') { | ||
| const classes = getPropValue(getProp(node.openingElement.attributes, 'className')) | ||
| const isVisuallyHiddenElement = node.openingElement.name.name === componentName | ||
| const hasSROnlyClass = typeof classes !== 'undefined' && classes.includes(className) | ||
| let isHidden = false | ||
|
|
||
| if (hasSROnlyClass || isVisuallyHiddenElement || !!isParentVisuallyHidden) { | ||
| if (checkIfInteractiveElement(context, htmlPropName, node)) { | ||
| return true | ||
| } | ||
| isHidden = true | ||
| } | ||
| if (node.children && node.children.length > 0) { | ||
| return ( | ||
| typeof node.children?.find(child => | ||
| checkIfVisuallyHiddenAndInteractive(context, options, child, !!isParentVisuallyHidden || isHidden), | ||
| ) !== 'undefined' | ||
| ) | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| module.exports = { | ||
| meta: { | ||
| docs: { | ||
| description: 'Ensures that interactive elements are not visually hidden', | ||
| url: require('../url')(module), | ||
| }, | ||
| schema: [schema], | ||
| }, | ||
|
|
||
| create(context) { | ||
| const {options} = context | ||
| const config = options[0] || {} | ||
| const className = config.className || defaultClassName | ||
| const componentName = config.componentName || defaultcomponentName | ||
| const htmlPropName = config.htmlPropName || defaultHtmlPropName | ||
|
|
||
| return { | ||
| JSXElement: node => { | ||
| if (checkIfVisuallyHiddenAndInteractive(context, {className, componentName, htmlPropName}, node, false)) { | ||
| context.report({ | ||
| node, | ||
| message: | ||
| 'Avoid visually hidding 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 the hidden element.', | ||
| }) | ||
| return | ||
| } | ||
| }, | ||
| } | ||
| }, | ||
| } | ||
This file contains 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,45 @@ | ||
| const rule = require('../lib/rules/a11y-no-visually-hidden-interactive-element') | ||
| const RuleTester = require('eslint').RuleTester | ||
|
|
||
| const ruleTester = new RuleTester({ | ||
| parserOptions: { | ||
| ecmaVersion: 'latest', | ||
| sourceType: 'module', | ||
| ecmaFeatures: { | ||
| jsx: true, | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| const errorMessage = | ||
| 'Avoid visually hidding 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 the hidden element.' | ||
|
|
||
| ruleTester.run('a11y-no-visually-hidden-interactive-element', rule, { | ||
|
There was a problem hiding this comment. Can we add a test to make sure the options work as expected? Here's an example! :) There was a problem hiding this comment. Amazing! I didn't realize that was a test option! |
||
| valid: [ | ||
| {code: '<VisuallyHidden as="h2">Submit</VisuallyHidden>'}, | ||
| {code: "<div className='sr-only'>Text</div>;"}, | ||
| {code: '<VisuallyHidden><div>Text</div></VisuallyHidden>'}, | ||
| {code: "<div className='other visually-hidden'>Text</div>;"}, | ||
| {code: "<span className='sr-only'>Text</span>;"}, | ||
| {code: "<button className='other'>Submit</button>"}, | ||
| {code: "<input className='sr-only' />"}, | ||
| {code: "<a className='other show-on-focus'>skip to main content</a>"}, | ||
|
There was a problem hiding this comment. Check that |
||
| {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: "<option 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.
Can we note the default class/type, as well as which interactive elements we're checking against?
I like the note you added in the code about why we're excluding
input. Could we add it here too?