Skip to content

fix(autocomplete): announce result to screen readers using aria-live attribute #12443

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
driskull merged 2 commits into from
Jul 3, 2025
Merged

fix(autocomplete): announce result to screen readers using aria-live attribute #12443

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
5f0f16c
fix(autocomplete): announce result to screen readers using aria-live …
driskull Jul 2, 2025
b194be0
test: add test
driskull Jul 3, 2025
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
8 changes: 8 additions & 0 deletions packages/calcite-components/src/components/autocomplete/autocomplete.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,14 @@ describe("calcite-autocomplete", () => {
focusable("calcite-autocomplete");
});

it("should set screen reader list attribute 'aria-live' to 'polite'", async () => {
const page = await newE2EPage();
await page.setContent(simpleHTML);

const screenReaderList = await page.find(`calcite-autocomplete >>> .${CSS.screenReadersOnly}`);
expect(await screenReaderList.getProperty("ariaLive")).toBe("polite");
});

it("should be able to remove icon", async () => {
const page = await newE2EPage();
await page.setContent(simpleHTML);
Expand Down
1 change: 1 addition & 0 deletions packages/calcite-components/src/components/autocomplete/autocomplete.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -867,6 +867,7 @@ export class Autocomplete
return (
<ul
aria-labelledby={this.inputId}
ariaLive="polite"
Copy link
Copy Markdown
Member

@jcfranco jcfranco Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we test for this attribute in an E2E test? I don’t think axe will catch it if it’s missing, so we’ll need to add explicit coverage.

class={CSS.screenReadersOnly}
id={this.listId}
role="listbox"
Expand Down
Loading