Skip to content

fix role "switch" requiring "aria-checked" when used with native input element #1071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 24, 2024
Merged

fix role "switch" requiring "aria-checked" when used with native input element #1071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8605261
fix #932 not required switch prop
JoCa96 Mar 25, 2024
69bb3a4
extended comment
JoCa96 Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/rules/__tests__/role-has-required-aria-props.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,21 @@ import makeRuleTester from "./makeRuleTester";

makeRuleTester("role-has-required-aria-props", rule, {
valid: [
"<input role='switch' type='checkbox' aria-labelledby='test' />",
"<span role='checkbox' aria-checked='false' aria-labelledby='test' tabindex='0' />",
"<span :role='role' aria-checked='false' aria-labelledby='test' tabindex='0' />",
"<span :role='role' />"
],
invalid: [
{
code: "<input role='switch' aria-labelledby='test' />",
errors: [
{
messageId: "default",
data: { role: "switch", attributes: "aria-checked" }
}
]
},
{
code: "<span role='checkbox' aria-labelledby='test' tabindex='0' />",
errors: [
Expand Down
25 changes: 24 additions & 1 deletion src/rules/role-has-required-aria-props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,24 @@ function isAriaRoleDefinitionKey(role: any): role is ARIARoleDefinitionKey {
return roles.has(role);
}

function filterRequiredPropsExceptions(
node: AST.VElement,
role: ARIARoleDefinitionKey,
elementType: string,
requiredProps: string[]
) {
// Based on the pattern recommendation in https://www.w3.org/WAI/ARIA/apg/patterns/switch/#wai-ariaroles,states,andproperties
// "aria-checked" should not be required when elementType is `input` and has the type attribute `checkbox`.
if (
role.toLowerCase() === "switch" &&
elementType === "input" &&
getElementAttributeValue(node, "type") === "checkbox"
) {
return requiredProps.filter((p) => p !== "aria-checked");
}
return requiredProps;
}

const rule: Rule.RuleModule = {
meta: {
type: "problem",
Expand Down Expand Up @@ -48,7 +66,12 @@ const rule: Rule.RuleModule = {
.forEach((role) => {
if (isAriaRoleDefinitionKey(role)) {
const roleDefinition = roles.get(role) as any;
const requiredProps = Object.keys(roleDefinition.requiredProps);
const requiredProps = filterRequiredPropsExceptions(
node,
role,
elementType,
Object.keys(roleDefinition.requiredProps)
);

if (requiredProps && !hasAttributes(node, requiredProps)) {
context.report({
Expand Down