Visitar URL original
fix(banner): resolve aria-controls in usa-banner web component by ryparker · Pull Request #7011 · uswds/uswds · GitHub
Skip to content

fix(banner): resolve aria-controls in usa-banner web component #7011

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

Draft
ryparker wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

fix(banner): resolve aria-controls in usa-banner web component #7011

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
72 changes: 72 additions & 0 deletions packages/usa-banner/src/test/usa-banner.component.spec.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import assert from "node:assert";
import UsaBanner from "../usa-banner.component.js";

const CONTROLS = "aria-controls";
const EXPANDED = "aria-expanded";
const EXPANDED_CLASS = "usa-banner__header--expanded";
const HIDDEN = "hidden";
Expand All @@ -25,6 +26,20 @@ function guidanceHeadings(shadow) {
.join(" | ");
}

// Resolve an IDREF the way assistive technology does: within the control's own
// tree, so an id in a shadow root is only visible to controls in that root.
function controlledBy(control) {
return control.getRootNode().getElementById(control.getAttribute(CONTROLS));
}

function assertExpandedMatchesContent(shadow) {
assert.strictEqual(
shadow.querySelector(".usa-banner__button").getAttribute(EXPANDED) ===
"true",
!shadow.querySelector(".usa-banner__content").hasAttribute(HIDDEN),
);
}

describe("usa-banner web component", () => {
afterEach(() => {
body.innerHTML = "";
Expand Down Expand Up @@ -247,5 +262,62 @@ describe("usa-banner web component", () => {
"button",
);
});

it("points aria-controls at the content in the same shadow root", async () => {
const { shadow } = await render();

assert.strictEqual(
controlledBy(shadow.querySelector(".usa-banner__button")),
shadow.querySelector(".usa-banner__content"),
);
});

it("keeps each banner's aria-controls scoped to its own content", async () => {
body.innerHTML = "<usa-banner></usa-banner><usa-banner></usa-banner>";
const [first, second] = Array.from(body.querySelectorAll("usa-banner"));
await Promise.all([first.updateComplete, second.updateComplete]);

first.shadowRoot.querySelector(".usa-banner__button").click();
await first.updateComplete;

[first, second].forEach((element) => {
const shadow = element.shadowRoot;
assert.strictEqual(
controlledBy(shadow.querySelector(".usa-banner__button")),
shadow.querySelector(".usa-banner__content"),
);
});
assertExpandedMatchesContent(first.shadowRoot);
assertExpandedMatchesContent(second.shadowRoot);
assert.strictEqual(
second.shadowRoot
.querySelector(".usa-banner__button")
.getAttribute(EXPANDED),
"false",
);
});

it("shows the content when isOpen is set as a property", async () => {
const { element, shadow } = await render();

element.isOpen = true;
await element.updateComplete;

assert.strictEqual(
shadow.querySelector(".usa-banner__button").getAttribute(EXPANDED),
"true",
);
assertExpandedMatchesContent(shadow);
});

it("shows the content when rendered with the isopen attribute", async () => {
const { shadow } = await render("<usa-banner isopen></usa-banner>");

assert.strictEqual(
shadow.querySelector(".usa-banner__button").getAttribute(EXPANDED),
"true",
);
assertExpandedMatchesContent(shadow);
});
});
});
9 changes: 5 additions & 4 deletions packages/usa-banner/src/usa-banner.component.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,6 @@ export default class UsaBanner extends LitElement {

toggle() {
this.isOpen = !this.isOpen;
this.shadowRoot
.querySelector(".usa-banner__content")
.toggleAttribute("hidden");
}

constructor() {
Expand Down Expand Up @@ -231,7 +228,11 @@ export default class UsaBanner extends LitElement {
</button>
</div>
</header>
<div class="usa-banner__content usa-accordion__content" hidden>
<div
class="usa-banner__content usa-accordion__content"
id="gov-banner-default"
?hidden=${!this.isOpen}
>
<div class="grid-row grid-gap-lg">
<div class="usa-banner__guidance tablet:grid-col-6">
${this.domainTemplate(tld)}
Expand Down
Loading