WIP: core(axe): new audits empty-table-header, frame-focusable-content #12536
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
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 @@ | ||
| <a href='/'>Home</a> |
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 |
|---|---|---|
|
|
@@ -134,7 +134,7 @@ const expectations = [ | |
| }, | ||
| 'selector': 'body > section > div > div#aria-treeitem-name', | ||
| 'snippet': '<div id="aria-treeitem-name" role="treeitem">', | ||
| 'explanation': 'Fix any of the following:\n Element does not have text that is visible to screen readers\n aria-label attribute does not exist or is empty\n aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty\n Element has no title attribute', | ||
|
There was a problem hiding this comment. these are just rearranging of the |
||
| 'nodeLabel': 'div', | ||
| }, | ||
| }, | ||
|
|
@@ -154,7 +154,7 @@ const expectations = [ | |
| }, | ||
| 'selector': 'body > section > div#aria-command-name', | ||
| 'snippet': '<div id="aria-command-name" role="button">', | ||
| 'explanation': 'Fix any of the following:\n Element does not have text that is visible to screen readers\n aria-label attribute does not exist or is empty\n aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty\n Element has no title attribute', | ||
| 'nodeLabel': 'div', | ||
| }, | ||
| }, | ||
|
|
@@ -174,7 +174,7 @@ const expectations = [ | |
| }, | ||
| 'selector': 'body > section > div#aria-tooltip-name', | ||
| 'snippet': '<div id="aria-tooltip-name" role="tooltip">', | ||
| 'explanation': 'Fix any of the following:\n Element does not have text that is visible to screen readers\n aria-label attribute does not exist or is empty\n aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty\n Element has no title attribute', | ||
| 'nodeLabel': 'div', | ||
| }, | ||
| }, | ||
|
|
@@ -239,7 +239,7 @@ const expectations = [ | |
| 'selector': 'body > section > div#aria-required-attr', | ||
| 'path': '2,HTML,1,BODY,19,SECTION,0,DIV', | ||
| 'snippet': '<div id="aria-required-attr" role="checkbox">', | ||
| 'explanation': 'Fix any of the following:\n Element does not have text that is visible to screen readers\n aria-label attribute does not exist or is empty\n aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty\n Element has no title attribute', | ||
| 'nodeLabel': 'div', | ||
| }, | ||
| }, | ||
|
|
@@ -314,7 +314,7 @@ const expectations = [ | |
| 'type': 'node', | ||
| 'selector': 'body > section > button#button-name', | ||
| 'snippet': '<button id="button-name">', | ||
| 'explanation': 'Fix any of the following:\n Element does not have inner text that is visible to screen readers\n aria-label attribute does not exist or is empty\n aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty\n Element has no title attribute\n Element\'s default semantics were not overridden with role="none" or role="presentation"', | ||
| 'nodeLabel': 'button', | ||
| }, | ||
| }, | ||
|
|
@@ -438,7 +438,7 @@ const expectations = [ | |
| node: { | ||
| 'type': 'node', | ||
| 'selector': 'body > section > input#form-field-multiple-labels', | ||
| 'path': '2,HTML,1,BODY,45,SECTION,2,INPUT', | ||
| 'snippet': '<input type="checkbox" id="form-field-multiple-labels">', | ||
| 'explanation': 'Fix all of the following:\n Multiple label elements is not widely supported in assistive technologies. Ensure the first label contains all necessary information.', | ||
| 'nodeLabel': 'input', | ||
|
|
@@ -456,7 +456,7 @@ const expectations = [ | |
| 'type': 'node', | ||
| 'selector': 'body > section > iframe#frame-title', | ||
| 'snippet': '<iframe id="frame-title">', | ||
| 'explanation': 'Fix any of the following:\n Element has no title attribute\n aria-label attribute does not exist or is empty\n aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty\n Element\'s default semantics were not overridden with role="none" or role="presentation"', | ||
| 'nodeLabel': 'iframe', | ||
| }, | ||
| }, | ||
|
|
@@ -471,7 +471,7 @@ const expectations = [ | |
| node: { | ||
| 'type': 'node', | ||
| 'selector': 'body > section > h3', | ||
| 'path': '2,HTML,1,BODY,51,SECTION,1,H3', | ||
| 'snippet': '<h3>', | ||
| 'explanation': 'Fix any of the following:\n Heading order invalid', | ||
| 'nodeLabel': 'sub-sub-header', | ||
|
|
@@ -690,6 +690,27 @@ const expectations = [ | |
| ], | ||
| }, | ||
| }, | ||
| 'frame-focusable-content': { | ||
| score: null, | ||
| scoreDisplayMode: 'notApplicable', | ||
|
There was a problem hiding this comment. I cannot get this audit to fail, no matter what I do. There are failing cases in the PR that introduced the rule (dequelabs/axe-core#2785), but even verbatim copy/pasting them doesn't seem to trigger it. When I step through axe-core, it appears the (notably the We should probably figure out an actual failure case and/or file a bug on why the axe test can fail but we can't (it's late, maybe I'm just missing something), but in the meantime, should we not include in the LH 8 release? |
||
| }, | ||
| 'empty-table-header': { | ||
| score: null, | ||
| details: { | ||
| items: [ | ||
| { | ||
| node: { | ||
| 'type': 'node', | ||
| 'selector': 'table > tbody > tr > th', | ||
| 'path': '2,HTML,1,BODY,43,SECTION,0,TABLE,0,TBODY,0,TR,0,TH', | ||
| 'snippet': '<th>', | ||
| 'explanation': 'Fix any of the following:\n Unable to determine if element has children', | ||
| 'nodeLabel': 'th', | ||
| }, | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
|
|
||
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,44 @@ | ||
| /** | ||
| * @license Copyright 2021 The Lighthouse Authors. All Rights Reserved. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| /** | ||
| * @fileoverview Ensures table headers have discernible text. | ||
| * See base class in axe-audit.js for audit() implementation. | ||
| */ | ||
|
|
||
| const AxeAudit = require('./axe-audit.js'); | ||
| const i18n = require('../../lib/i18n/i18n.js'); | ||
|
|
||
| const UIStrings = { | ||
| /** Title of an accesibility audit that checks if there are any table headers without visible text. This title is descriptive of the successful state and is shown to users when no user action is required. */ | ||
| title: '`table` headers have visible text', | ||
| /** Title of an accesibility audit that checks if there are any table headers without visible text. This title is descriptive of the failing state and is shown to users when there is a failure that needs to be addressed. */ | ||
| failureTitle: '`table` headers do not have visible text', | ||
| /** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */ | ||
| description: '`table` headers should have visible text so assistive technologies like screen readers may describe table contents appropriately. [Learn more](https://dequeuniversity.com/rules/axe/4.2/empty-table-header).', | ||
| }; | ||
|
|
||
| const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings); | ||
|
|
||
| class EmptyTableHeader extends AxeAudit { | ||
| /** | ||
| * @return {LH.Audit.Meta} | ||
| */ | ||
| static get meta() { | ||
| return { | ||
| id: 'empty-table-header', | ||
| title: str_(UIStrings.title), | ||
| failureTitle: str_(UIStrings.failureTitle), | ||
| description: str_(UIStrings.description), | ||
| scoreDisplayMode: AxeAudit.SCORING_MODES.INFORMATIVE, | ||
|
There was a problem hiding this comment.
I was out on leave for that PR so I don't have all the background, but today it does seems a little strange to not have it count for anything when passing, even if That said, it seems like our Maybe for now we should drop this audit after all and re-add it when/if it gains some certainty? There was a problem hiding this comment. |
||
| requiredArtifacts: ['Accessibility'], | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| module.exports = EmptyTableHeader; | ||
| module.exports.UIStrings = UIStrings; | ||
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,43 @@ | ||
| /** | ||
| * @license Copyright 2021 The Lighthouse Authors. All Rights Reserved. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| /** | ||
| * @fileoverview No `<iframe tabindex=-1>` has focusable content. | ||
| * See base class in axe-audit.js for audit() implementation. | ||
| */ | ||
|
|
||
| const AxeAudit = require('./axe-audit.js'); | ||
| const i18n = require('../../lib/i18n/i18n.js'); | ||
|
|
||
| const UIStrings = { | ||
| /** Title of an accesibility audit that checks if there are any iframes with focusable content that mistakenly set tabindex = -1. This title is descriptive of the successful state and is shown to users when no user action is required. */ | ||
| title: '`<iframe>` elements with focusable content do not have a negative `tabindex`', | ||
| /** Title of an accesibility audit that checks if there are any iframes with focusable content that mistakently set tabindex = -1. This title is descriptive of the failing state and is shown to users when there is a failure that needs to be addressed. */ | ||
| failureTitle: '`<iframe>` elements with focusable content have a negative `tabindex`', | ||
| /** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */ | ||
| description: 'Focusable elements within an `<iframe>` element with a negative `tabindex` cannot be reached via keyboard navigation. [Learn more](https://dequeuniversity.com/rules/axe/4.2/frame-focusable-content).', | ||
| }; | ||
|
|
||
| const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings); | ||
|
|
||
| class FrameFocusableContent extends AxeAudit { | ||
| /** | ||
| * @return {LH.Audit.Meta} | ||
| */ | ||
| static get meta() { | ||
| return { | ||
| id: 'frame-focusable-content', | ||
| title: str_(UIStrings.title), | ||
| failureTitle: str_(UIStrings.failureTitle), | ||
| description: str_(UIStrings.description), | ||
| requiredArtifacts: ['Accessibility'], | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| module.exports = FrameFocusableContent; | ||
| module.exports.UIStrings = UIStrings; |
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
Oops, something went wrong.
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.
this needs to be an appropriate use of
aria-labelledbyor this now gets flagged byaria-allowed-attr. Nice upgrade for that audit