add help text (and links) to a11y audits #1589
Conversation
|
Seems OK to me. I'm aware from the computer for a bit but I'll check it in my smoke test when I get back. Thanks for doing this! |
|
Just started reviewing :) |
Sent from 
| @@ -33,6 +33,9 @@ class ImageAlt extends AxeAudit { | |||
| category: 'Accessibility', | |||
| name: 'image-alt', | |||
| description: 'Every image element has an alt attribute', | |||
| helpText: 'Screen readers can\'t read images to their users. The `alt` ' + | |||
There was a problem hiding this comment.
Suggest changing to something like "Screen reader users rely on alt text to provide descriptions for images. It's also used as fallback content if the image fails to load"
| @@ -34,6 +34,9 @@ class ColorContrast extends AxeAudit { | |||
| category: 'Accessibility', | |||
| name: 'color-contrast', | |||
| description: 'Background and foreground colors have a sufficient contrast ratio', | |||
| helpText: 'Some users with low vision have a difficult time sensing contrast. ' + | |||
There was a problem hiding this comment.
Suggest rewording to "Low contrast text is difficult or impossible for many users to read."
| @@ -33,6 +33,8 @@ class ARIAAllowedAttr extends AxeAudit { | |||
| category: 'Accessibility', | |||
| name: 'aria-allowed-attr', | |||
| description: 'Element aria-* attributes are allowed for this role', | |||
| helpText: 'Invalid role-attribute combinations can disable the accessibility ' + | |||
There was a problem hiding this comment.
Suggest rewording to something like "Each ARIA role defines a specific subset of aria-* attributes that it supports. Mismatching these will invalidate the aria-* attributes."
| @@ -33,6 +33,8 @@ class ARIARequiredAttr extends AxeAudit { | |||
| category: 'Accessibility', | |||
| name: 'aria-required-attr', | |||
| description: 'Elements with ARIA roles have the required aria-* attributes', | |||
| helpText: 'Some ARIA roles have required attributes that describe the state ' + | |||
| 'of the role to screen readers. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/required-aria-attributes).', | |||
There was a problem hiding this comment.
Might change this to "state of the element".
| @@ -33,6 +33,8 @@ class ARIAValidAttr extends AxeAudit { | |||
| category: 'Accessibility', | |||
| name: 'aria-valid-attr-value', | |||
| description: 'Element aria-* attributes have valid values', | |||
| helpText: 'Screen readers may not be able to read elements with invalid ARIA ' + | |||
There was a problem hiding this comment.
Suggest rewording to something like "Assistive technology, such as a screen reader, will not be able to interpret ARIA attributes with invalid values"
| @@ -33,6 +33,8 @@ class ARIAValidAttr extends AxeAudit { | |||
| category: 'Accessibility', | |||
| name: 'aria-valid-attr', | |||
| description: 'Element aria-* attributes are valid and not misspelled or non-existent.', | |||
| helpText: 'Screen readers may not be able to read elements with invalid ARIA ' + | |||
There was a problem hiding this comment.
Suggest rewording to something like "Assistive technology, such as a screen reader, will not be able to interpret ARIA attributes with invalid attribute names"
| @@ -33,6 +33,9 @@ class Label extends AxeAudit { | |||
| category: 'Accessibility', | |||
| name: 'label', | |||
| description: 'Every form element has a label', | |||
| helpText: 'Although the purpose of each form element may be obvious ' + | |||
There was a problem hiding this comment.
Suggest rewording to "Labels ensure that form controls are announced properly by assistive technology, such as a screen reader"
|
Hallo mr @robdodson "updates were made" |
WDYT @robdodson PTAL LGTY?