feat: added new custom rule sa11y-Keyboard-button (#760)

salesforce · Nov 8, 2024 · 10067c9 · 10067c9
1 parent 3a71ac1
commit 10067c9
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/packages/preset-rules/src/custom-rules/checks.ts b/packages/preset-rules/src/custom-rules/checks.ts
@@ -30,6 +30,15 @@ const checkData = [
             },
         },
     },
+    {
+        id: 'sa11y-Keyboard-button-check',
+        evaluate:
+            "function (node) { const tabIndex = node.getAttribute('tabindex'); if ( tabIndex === '-1' && node.actualNode && !isVisibleOnScreen(node) && !isVisibleToScreenReaders(node)) { return false; } if(!node.innerText ===\"\"){ return false; } if(!node.hasAttribute('tabindex')){ return false; } return true; }",
+        messages: {
+            pass: 'Button element are keyboard operable',
+            fail: "Button element are not keyboard operable, To fix add tabindex='0' attribute and appropriate keyboard event handler.",
+        },
+    },
 ];
 
 export default checkData as axe.Check[];
diff --git a/packages/preset-rules/src/custom-rules/rules.ts b/packages/preset-rules/src/custom-rules/rules.ts
@@ -34,6 +34,24 @@ const rulesData = [
             tags: ['wcag1410', 'custom'],
         },
     },
+    {
+        id: 'sa11y-Keyboard-button',
+        selector:
+            "[role='button']:not(a[href],button,input,select,area[href],textarea,[contentEditable=true],[disabled],details)",
+        enabled: true,
+        any: ['sa11y-Keyboard-button-check'],
+        all: [],
+        metadata: {
+            description: 'Element is not keyboard operable',
+            help: "Fix any one of the following :\n \
+                       1.The button element missing keyboard operability. To fix add tabindex='0' attribute and  appropriate keyboard event handler.\n \
+                       2.Remove role='button' attribute",
+            helpUrl: '',
+
+            impact: 'critical',
+            tags: ['wcag211', 'custom'],
+        },
+    },
 ];
 
 export default rulesData as axe.Rule[];