Skip to content

Use document.title as fallback accessible name for html root element #446

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
calebeby merged 2 commits into from
Mar 31, 2022
Merged

Use document.title as fallback accessible name for html root element #446

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
bac231d
Use document.title as fallback accessible name for html root element
calebeby Mar 29, 2022
431dcde
Clarify changeset
calebeby Mar 29, 2022
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/popular-beans-roll.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'pleasantest': major
---

Use document.title as fallback implicit accessible name for html root element in accessibility tree snapshots
10 changes: 9 additions & 1 deletion src/accessibility/browser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,15 @@ export const getAccessibilityTree = (
);
let text = (selfIsInAccessibilityTree && role) || '';
if (selfIsInAccessibilityTree) {
const name = computeAccessibleName(element);
let name = computeAccessibleName(element);
if (
element === document.documentElement &&
role === 'document' &&
!name &&
document.title
) {
name = document.title;
}
if (name) text += ` "${name}"`;
if (document.activeElement === element) text += ` (focused)`;
if (includeDescriptions) {
Expand Down
83 changes: 41 additions & 42 deletions tests/accessibility/getAccessibilityTree.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@ test(
expect(String(await getAccessibilityTree(htmlElement))).toEqual(
String(await getAccessibilityTree(page)),
);
// TODO: document's name should be from document.title (breaking change)
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "example title"
list
`);

Expand All @@ -40,7 +39,7 @@ test(
</main>
`);
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
main
button "Add to cart"
heading "hiiii"
Expand All @@ -54,7 +53,7 @@ test(
</ul>
`);
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
list
listitem
text "something"
Expand All @@ -63,21 +62,21 @@ test(
`);
expect(await getAccessibilityTree(page, { includeText: true }))
.toMatchInlineSnapshot(`
document
list
listitem
text "something"
listitem
text "something else"
`);
document "pleasantest"
list
listitem
text "something"
listitem
text "something else"
`);
await utils.injectHTML(`
<button aria-describedby="click-me-description">click me</button>
<button aria-describedby="click-me-description"><div>click me</div></button>
<button aria-describedby="click-me-description"><h1>click me</h1></button>
<div id="click-me-description">extended description</div>
`);
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
button "click me"
↳ description: "extended description"
button "click me"
Expand All @@ -88,24 +87,24 @@ test(
`);
expect(await getAccessibilityTree(page, { includeText: true }))
.toMatchInlineSnapshot(`
document
button "click me"
↳ description: "extended description"
button "click me"
↳ description: "extended description"
button "click me"
↳ description: "extended description"
text "extended description"
`);
document "pleasantest"
button "click me"
↳ description: "extended description"
button "click me"
↳ description: "extended description"
button "click me"
↳ description: "extended description"
text "extended description"
`);

expect(await getAccessibilityTree(page, { includeDescriptions: false }))
.toMatchInlineSnapshot(`
document
button "click me"
button "click me"
button "click me"
text "extended description"
`);
document "pleasantest"
button "click me"
button "click me"
button "click me"
text "extended description"
`);

await utils.injectHTML(`
<label>
Expand All @@ -119,12 +118,12 @@ test(

expect(await getAccessibilityTree(page, { includeText: true }))
.toMatchInlineSnapshot(`
document
text "Label Text"
textbox "Label Text"
text "Label Text"
textbox "Label Text"
`);
document "pleasantest"
text "Label Text"
textbox "Label Text"
text "Label Text"
textbox "Label Text"
`);
}),
);

Expand Down Expand Up @@ -157,7 +156,7 @@ test(
</div>
`);
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
button "A"
button "E"
button "G"
Expand All @@ -174,14 +173,14 @@ test(
// Role="presentation" and role="none" are equivalent
// They make it as if the outer element wasn't there.
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
text "Sample Content"
`);
await utils.injectHTML(`<h1 role="none">Sample Content</h1>`);
// Role="presentation" and role="none" are equivalent
// They make it as if the outer element wasn't there.
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
text "Sample Content"
`);

Expand All @@ -198,7 +197,7 @@ test(
</ul>
`);
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
text "Sample Content"
text "More Sample Content"
heading "Hi"
Expand All @@ -216,7 +215,7 @@ test(
</ul>
`);
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
text "Sample Content"
text "More Sample Content"
listitem
Expand All @@ -233,7 +232,7 @@ test(
</ul>
`);
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
text "Sample Content"
text "More Sample Content"
heading "Hi"
Expand All @@ -250,7 +249,7 @@ test(
</ul>
`);
expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
heading "Sample Content"
listitem
text "Sample Content"
Expand All @@ -269,14 +268,14 @@ test(
`);

expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
button "Click me!"
`);

await user.click(await screen.getByRole('button'));

expect(await getAccessibilityTree(page)).toMatchInlineSnapshot(`
document
document "pleasantest"
button "Click me!" (focused)
`);
}),
Expand Down