Skip to content
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

fix: dynamically calculate th aria role #1073

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: dynamically calculate th aria role #1073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/healthy-jobs-act.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"dom-accessibility-api": patch
---

Dynamically calculates the aria role for <th> elements instead of always returning 'columnheader'
10 changes: 8 additions & 2 deletions sources/__tests__/getRole.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,13 @@ const cases = [
["title", null, createElementFactory("title", {})],
// WARNING: Only in certain contexts
["td", "cell", createElementFactory("td", {})],
["th", "columnheader", createElementFactory("th", {})],
// default scope=auto
["th missing scope", "columnheader", createElementFactory("th", {})],
["th scope explicitly set to `auto`", "columnheader", createElementFactory("th", {scope:"auto"})],
["th scope=col", "columnheader", createElementFactory("th", {scope:"col"})],
["th scope=colgroup", "columnheader", createElementFactory("th", {scope:"colgroup"})],
["th scope=row", "rowheader", createElementFactory("th", {scope:"row"})],
["th scope=rowgroup", "rowheader", createElementFactory("th", {scope:"rowgroup"})],
["tr", "row", createElementFactory("tr", {})],
["track", null, createElementFactory("track", {})],
["ul", "list", createElementFactory("ul", {})],
Expand All @@ -182,7 +188,7 @@ const cases = [
["presentational <div /> with prohibited aria attributes", null, createElementFactory("div", {'aria-label': "hello", role: "none"})],
];

it.each(cases)("%s has the role %s", (name, role, elementFactory) => {
it.each(cases)("%s has the role %s", (_name, role, elementFactory) => {
const element = elementFactory();

expect(getRole(element)).toEqual(role);
Expand Down
17 changes: 14 additions & 3 deletions sources/getRole.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ const localNameToRoleMappings: Record<string, string | undefined> = {
tfoot: "rowgroup",
// WARNING: Only in certain context
td: "cell",
th: "columnheader",
thead: "rowgroup",
tr: "row",
ul: "list",
Expand Down Expand Up @@ -143,12 +142,13 @@ export default function getRole(element: Element): string | null {
}

function getImplicitRole(element: Element): string | null {
const mappedByTag = localNameToRoleMappings[getLocalName(element)];
const elName = getLocalName(element);
const mappedByTag = localNameToRoleMappings[elName];
if (mappedByTag !== undefined) {
return mappedByTag;
}

switch (getLocalName(element)) {
switch (elName) {
case "a":
case "area":
case "link":
Expand Down Expand Up @@ -205,6 +205,17 @@ function getImplicitRole(element: Element): string | null {
return "listbox";
}
return "combobox";
case "th":
switch (element.getAttribute("scope")) {
case "row":
case "rowgroup":
return "rowheader";
case "col":
case "colgroup":
case "auto":
default:
return "columnheader";
}
}
return null;
}
Expand Down
Loading