← Recipes

阅读中文版本

Announce Dynamic Updates with aria-live Regions

Add an aria-live region so screen readers announce search results and toast notifications without the user moving focus.

~15 minfrontendaccessibilityaria

Task

Add <div aria-live="polite" aria-atomic="true">{announcement}</div> so the interface remains usable and accessible under the edge cases that manual testing skips.

When to use this

A screen reader user reports the page is unusable because <div aria-live="polite" aria-atomic="true">{announcement}</div> was never implemented, flagged in a support ticket.

Prerequisites

  • A frontend component or page in the codebase
  • A build with the relevant framework configured

Steps

1. Configure <div aria-live="polite" aria-atomic="true">{announcement}</div> in the project configuration file with the recommended defaults.

<div aria-live="polite" aria-atomic="true">{announcement}</div>

Expected output: The configuration is accepted and <div aria-live="polite" aria-atomic="true">{announcement}</div> runs without errors on the first invocation.

2. Run the check locally to verify <div aria-live="polite" aria-atomic="true">{announcement}</div> produces the expected result before pushing.

pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so <div aria-live="polite" aria-atomic="true">{announcement}</div> blocks merge on failure.

- name: Run add accessible aria live region
  run: pnpm test

Expected output: Pull requests with failing <div aria-live="polite" aria-atomic="true">{announcement}</div> are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Handle the edge case

Start by measuring the problem. Add an aria-live region so screen readers announce search results and toast notifications without the user moving focus. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run

{announcement}
against the current codebase and inspect the output before wiring it into CI.

<div aria-live="polite" aria-atomic="true">{announcement}</div>

Test with real tools

Once the gate is in place, make failures actionable. A failing

{announcement}
should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.