feat: axe 3160 bulk nr and perception

build/tasks/validate.js

@@ -227,6 +227,15 @@ function createSchemas() {
           description: {
             required: true,
             type: 'string'
+          },
+          violationConfidence: {
+            type: 'number',
+          },
+          needsReviewConfidence: {
+            type: 'number',
+          },
+          defaultCategory: {
+            type: 'string',
           }
         }
       }

lib/checks/aria/aria-prohibited-attr-evaluate.js

@@ -59,7 +59,16 @@ export default function ariaProhibitedAttrEvaluate(
 
   let messageKey = role !== null ? 'hasRole' : 'noRole';
   messageKey += prohibited.length > 1 ? 'Plural' : 'Singular';
-  this.data({ role, nodeName, messageKey, prohibited });
+  // a11y-rule-aria-prohibited-attr: reviewPayload for bulk NR
+  const accessibleName =
+    axe.commons.text.accessibleText(node)
+  this.data({
+    role,
+    nodeName,
+    messageKey,
+    prohibited,
+    reviewPayload: { visualHelperData: { accessibleName } }
+  });
 
   // `subtreeDescendant` to override namedFromContents
   const textContent = subtreeText(virtualNode, { subtreeDescendant: true });

lib/checks/color/color-contrast-evaluate.js

@@ -148,7 +148,16 @@ export default function colorContrastEvaluate(node, options, virtualNode) {
       fontWeight: bold ? 'bold' : 'normal',
       messageKey: missing,
       expectedContrastRatio: expected + ':1',
-      shadowColor: shadowColor ? shadowColor.toHexString() : undefined
+      shadowColor: shadowColor ? shadowColor.toHexString() : undefined,
+      // a11y-rule-color-contrast: reviewPayload for bulk NR
+      reviewPayload: {
+        visualHelperData: {
+          fgColor: fgColor ? fgColor.toHexString() : null,
+          bgColor: bgColor ? bgColor.toHexString() : null,
+          isLargeText: !isSmallFont,
+          textContent: visibleText ? (visibleText.length <= 100 ? visibleText : visibleText.slice(0, visibleText.lastIndexOf(' ', 100) || 100)) : null
+        }
+      }
     });
 
     // We don't know, so we'll put it into Can't Tell

lib/checks/label/label-content-name-mismatch-evaluate.js

@@ -140,10 +140,29 @@ function labelContentNameMismatchEvaluate(node, options, virtualNode) {
     isHumanInterpretable(accText) < 1 ||
     isHumanInterpretable(visibleText) < 1
   ) {
+    // a11y-rule-label-content-name-mismatch: reviewPayload for bulk NR
+    this.data({
+      reviewPayload: {
+        visualHelperData: {
+          accessibleName: accText || null
+        }
+      }
+    });
     return undefined;
   }
 
-  return isStringContained(visibleText, accText);
+  const result = isStringContained(visibleText, accText);
+  if (!result) {
+    // a11y-rule-label-content-name-mismatch: reviewPayload for bulk NR
+    this.data({
+      reviewPayload: {
+        visualHelperData: {
+          accessibleName: accText || null
+        }
+      }
+    });
+  }
+  return result;
 }
 
 export default labelContentNameMismatchEvaluate;

lib/rules/accesskeys.json

@@ -6,7 +6,8 @@
   "tags": ["cat.keyboard", "best-practice"],
   "metadata": {
     "description": "Ensure every accesskey attribute value is unique",
-    "help": "accesskey attribute value should be unique"
+    "help": "accesskey attribute value should be unique",
+    "violationConfidence": 99
   },
   "all": [],
   "any": [],

lib/rules/aria-allowed-attr.json

@@ -14,7 +14,8 @@
   "actIds": ["5c01ea"],
   "metadata": {
     "description": "Ensure an element's role supports its ARIA attributes",
-    "help": "Elements must only use supported ARIA attributes"
+    "help": "Elements must only use supported ARIA attributes",
+    "needsReviewConfidence": 50
   },
   "all": ["aria-allowed-attr"],
   "any": [],

lib/rules/aria-allowed-role.json

@@ -7,7 +7,8 @@
   "tags": ["cat.aria", "best-practice"],
   "metadata": {
     "description": "Ensure role attribute has an appropriate value for the element",
-    "help": "ARIA role should be appropriate for the element"
+    "help": "ARIA role should be appropriate for the element",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": ["aria-allowed-role"],

lib/rules/aria-hidden-focus.json

@@ -18,7 +18,8 @@
   "actIds": ["6cfa84"],
   "metadata": {
     "description": "Ensure aria-hidden elements are not focusable nor contain focusable elements",
-    "help": "ARIA hidden element must not be focusable or contain focusable elements"
+    "help": "ARIA hidden element must not be focusable or contain focusable elements",
+    "needsReviewConfidence": 50
   },
   "all": [
     "focusable-modal-open",

lib/rules/aria-input-field-name.json

@@ -18,7 +18,8 @@
   "actIds": ["e086e5"],
   "metadata": {
     "description": "Ensure every ARIA input field has an accessible name",
-    "help": "ARIA input fields must have an accessible name"
+    "help": "ARIA input fields must have an accessible name",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": ["aria-label", "aria-labelledby", "non-empty-title"],

lib/rules/aria-meter-name.json

@@ -14,7 +14,8 @@
   ],
   "metadata": {
     "description": "Ensure every ARIA meter node has an accessible name",
-    "help": "ARIA meter nodes must have an accessible name"
+    "help": "ARIA meter nodes must have an accessible name",
+    "violationConfidence": 99
   },
   "all": [],
   "any": ["aria-label", "aria-labelledby", "non-empty-title"],

lib/rules/aria-prohibited-attr.json

@@ -14,7 +14,10 @@
   "actIds": ["5c01ea"],
   "metadata": {
     "description": "Ensure ARIA attributes are not prohibited for an element's role",
-    "help": "Elements must only use permitted ARIA attributes"
+    "help": "Elements must only use permitted ARIA attributes",
+    "violationConfidence": 90,
+    "needsReviewConfidence": 50,
+    "defaultCategory": "names-and-labels"
   },
   "all": [],
   "any": [],

lib/rules/aria-required-children.json

@@ -15,7 +15,8 @@
   "actIds": ["bc4a75", "ff89c9"],
   "metadata": {
     "description": "Ensure elements with an ARIA role that require child roles contain them",
-    "help": "Certain ARIA roles must contain particular children"
+    "help": "Certain ARIA roles must contain particular children",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": ["aria-required-children"],

lib/rules/aria-toggle-field-name.json

@@ -18,7 +18,8 @@
   "actIds": ["e086e5"],
   "metadata": {
     "description": "Ensure every ARIA toggle field has an accessible name",
-    "help": "ARIA toggle fields must have an accessible name"
+    "help": "ARIA toggle fields must have an accessible name",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": [

lib/rules/aria-treeitem-name.json

@@ -6,7 +6,8 @@
   "tags": ["cat.aria", "best-practice"],
   "metadata": {
     "description": "Ensure every ARIA treeitem node has an accessible name",
-    "help": "ARIA treeitem nodes should have an accessible name"
+    "help": "ARIA treeitem nodes should have an accessible name",
+    "violationConfidence": 99
   },
   "all": [],
   "any": [

lib/rules/aria-valid-attr-value.json

@@ -14,7 +14,8 @@
   "actIds": ["6a7281"],
   "metadata": {
     "description": "Ensure all ARIA attributes have valid values",
-    "help": "ARIA attributes must conform to valid values"
+    "help": "ARIA attributes must conform to valid values",
+    "needsReviewConfidence": 50
   },
   "all": ["aria-valid-attr-value", "aria-errormessage", "aria-level"],
   "any": [],

lib/rules/blink.json

@@ -18,7 +18,8 @@
   ],
   "metadata": {
     "description": "Ensure <blink> elements are not used",
-    "help": "<blink> elements are deprecated and must not be used"
+    "help": "<blink> elements are deprecated and must not be used",
+    "violationConfidence": 99
   },
   "all": [],
   "any": [],

lib/rules/button-name.json

@@ -20,7 +20,8 @@
   "actIds": ["97a4e1", "m6b1q3"],
   "metadata": {
     "description": "Ensure buttons have discernible text",
-    "help": "Buttons must have discernible text"
+    "help": "Buttons must have discernible text",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": [

lib/rules/bypass.json

@@ -21,7 +21,8 @@
   "actIds": ["cf77f2", "047fe0", "b40fd1", "3e12e1", "ye5d6e"],
   "metadata": {
     "description": "Ensure each page has at least one mechanism for a user to bypass navigation and jump straight to the content",
-    "help": "Page must have means to bypass repeated blocks"
+    "help": "Page must have means to bypass repeated blocks",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": ["internal-link-present", "header-present", "landmark"],

lib/rules/color-contrast-enhanced.json

@@ -8,7 +8,9 @@
   "actIds": ["09o5cg"],
   "metadata": {
     "description": "Ensure the contrast between foreground and background colors meets WCAG 2 AAA enhanced contrast ratio thresholds",
-    "help": "Elements must meet enhanced color contrast ratio thresholds"
+    "help": "Elements must meet enhanced color contrast ratio thresholds",
+    "needsReviewConfidence": 50,
+    "defaultCategory": "text-contrast-enhanced"
   },
   "all": [],
   "any": ["color-contrast-enhanced"],

lib/rules/color-contrast.json

@@ -18,7 +18,9 @@
   "actIds": ["afw4f7", "09o5cg"],
   "metadata": {
     "description": "Ensure the contrast between foreground and background colors meets WCAG 2 AA minimum contrast ratio thresholds",
-    "help": "Elements must meet minimum color contrast ratio thresholds"
+    "help": "Elements must meet minimum color contrast ratio thresholds",
+    "needsReviewConfidence": 50,
+    "defaultCategory": "text-contrast"
   },
   "all": [],
   "any": ["color-contrast"],

lib/rules/css-orientation-lock.json

@@ -17,7 +17,9 @@
   "actIds": ["b33eff"],
   "metadata": {
     "description": "Ensure content is not locked to any specific display orientation, and the content is operable in all display orientations",
-    "help": "CSS Media queries must not lock display orientation"
+    "help": "CSS Media queries must not lock display orientation",
+    "violationConfidence": 90,
+    "needsReviewConfidence": 50
   },
   "all": ["css-orientation-lock"],
   "any": [],

lib/rules/duplicate-id-aria.json

@@ -17,7 +17,8 @@
   "actIds": ["3ea0c8"],
   "metadata": {
     "description": "Ensure every id attribute value used in ARIA and in labels is unique",
-    "help": "IDs used in ARIA and labels must be unique"
+    "help": "IDs used in ARIA and labels must be unique",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": ["duplicate-id-aria"],

lib/rules/focus-order-semantics.json

@@ -14,7 +14,8 @@
   ],
   "metadata": {
     "description": "Ensure elements in the focus order have a role appropriate for interactive content",
-    "help": "Elements in the focus order should have an appropriate role"
+    "help": "Elements in the focus order should have an appropriate role",
+    "violationConfidence": 90
   },
   "all": [],
   "any": ["has-widget-role", "valid-scrollable-semantics"],

lib/rules/form-field-multiple-labels.json

@@ -16,7 +16,8 @@
   ],
   "metadata": {
     "description": "Ensure form field does not have multiple label elements",
-    "help": "Form field must not have multiple label elements"
+    "help": "Form field must not have multiple label elements",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": [],

lib/rules/frame-title-unique.json

@@ -17,7 +17,8 @@
   "actIds": ["4b1c6c"],
   "metadata": {
     "description": "Ensure <iframe> and <frame> elements contain a unique title attribute",
-    "help": "Frames must have a unique title attribute"
+    "help": "Frames must have a unique title attribute",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": [],

lib/rules/heading-order-bp.json

@@ -6,7 +6,8 @@
   "tags": ["cat.structure", "best-practice", "a11y-engine"],
   "metadata": {
     "description": "Ensure the order of headings is semantically correct",
-    "help": "Heading levels should only increase by one"
+    "help": "Heading levels should only increase by one",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": ["heading-order"],

lib/rules/heading-order.json

@@ -6,7 +6,8 @@
   "tags": ["cat.structure", "wcag2aaa", "wcag2410", "a11y-engine"],
   "metadata": {
     "description": "Ensure the order of headings is semantically correct",
-    "help": "Heading levels must only increase by one"
+    "help": "Heading levels must only increase by one",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": ["heading-order"],

lib/rules/hidden-content.json

@@ -13,7 +13,8 @@
   ],
   "metadata": {
     "description": "Inform users about hidden content.",
-    "help": "Hidden content on the page should be analyzed"
+    "help": "Hidden content on the page should be analyzed",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": ["hidden-content"],

lib/rules/identical-links-same-purpose.json

@@ -9,7 +9,8 @@
   "actIds": ["b20e66"],
   "metadata": {
     "description": "Ensure that links with the same accessible name serve a similar purpose",
-    "help": "Links with the same name must have a similar purpose"
+    "help": "Links with the same name must have a similar purpose",
+    "needsReviewConfidence": 50
   },
   "all": ["identical-links-same-purpose"],
   "any": [],

lib/rules/label-content-name-mismatch.json

@@ -17,7 +17,10 @@
   "actIds": ["2ee8b8"],
   "metadata": {
     "description": "Ensure that elements labelled through their content must have their visible text as part of their accessible name",
-    "help": "Elements must have their visible text as part of their accessible name"
+    "help": "Elements must have their visible text as part of their accessible name",
+    "violationConfidence": 80,
+    "needsReviewConfidence": 50,
+    "defaultCategory": "names-and-labels"
   },
   "all": [],
   "any": ["label-content-name-mismatch"],

lib/rules/link-in-text-block.json

@@ -17,7 +17,9 @@
   ],
   "metadata": {
     "description": "Ensure links are distinguished from surrounding text in a way that does not rely on color",
-    "help": "Links must be distinguishable without relying on color"
+    "help": "Links must be distinguishable without relying on color",
+    "needsReviewConfidence": 50,
+    "defaultCategory": "links"
   },
   "any": ["link-in-text-block", "link-in-text-block-style"],
   "all": [

lib/rules/nested-interactive.json

@@ -16,7 +16,8 @@
   "actIds": ["307n5z"],
   "metadata": {
     "description": "Ensure interactive controls are not nested as they are not always announced by screen readers or can cause focus problems for assistive technologies",
-    "help": "Interactive controls must not be nested"
+    "help": "Interactive controls must not be nested",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": ["no-focusable-content"],

lib/rules/target-size.json

@@ -7,7 +7,8 @@
   "tags": ["cat.sensory-and-visual-cues", "wcag22aa", "wcag258"],
   "metadata": {
     "description": "Ensure touch targets have sufficient size and space",
-    "help": "All touch targets must be 24px large, or leave sufficient space"
+    "help": "All touch targets must be 24px large, or leave sufficient space",
+    "needsReviewConfidence": 50
   },
   "all": [],
   "any": ["target-size", "target-offset"],

lib/rules/th-has-data-cells.json

@@ -19,7 +19,8 @@
   "actIds": ["d0f69e"],
   "metadata": {
     "description": "Ensure that <th> elements and elements with role=columnheader/rowheader have data cells they describe",
-    "help": "Table headers in a data table must refer to data cells"
+    "help": "Table headers in a data table must refer to data cells",
+    "needsReviewConfidence": 50
   },
   "all": ["th-has-data-cells"],
   "any": [],