Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
MelSumner committed May 29, 2024
1 parent 5d4bf73 commit 55e3ecd
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
[![Ember Observer Score](https://emberobserver.com/badges/ember-a11y-refocus.svg)](http://emberobserver.com/addons/ember-a11y-refocus)
[![Build status](https://github.com/ember-a11y/ember-a11y-refocus/actions/workflows/main.yml/badge.svg)](https://github.com/ember-a11y/ember-a11y-refocus/actions)


## What This Addon Does

This addon does three things:

1. it adds a message to the page to let the screen reader user know that the route has changed and regular page navigation can resume (it is similar to [https://github.com/ember-a11y/a11y-announcer](https://github.com/ember-a11y/a11y-announcer) but does not use `aria-live`).
2. It moves the focus to that message for the screen reader user, effectively resetting focus in Ember apps (similar to how a native web page/site works).
3. It provides a bypass mechanism so the user can skip to the page's primary content (see https://www.w3.org/TR/WCAG20-TECHS/G1.html). You can opt out of this if you want (see the `Options` section for available options).
Expand All @@ -28,14 +28,12 @@ Async data can be loaded as it normally would be. Since this addon does not use

Since this will run before other content, focus can be programmatically moved by the developer to go somewhere else. The message should still read out, and is findable by users with screen readers.



Compatibility
------------------------------------------------------------------------------

* Ember.js v3.26 or above
* Ember CLI v3.26 or above
* Node.js v12 or above
* Node.js v14 or above

Installation
------------------------------------------------------------------------------
Expand Down

0 comments on commit 55e3ecd

Please sign in to comment.