Accessibility: Page Loader indicator using aria-live

All we need is an easy explanation of the problem, so here it is.

Issue: I have an accessibility issue that I am struggling with. I have an angular web application. A page loading spinner/indicator is shown when content is loading. And when the page content has loaded the spinner is hidden. This “div” is never removed from DOM.

Content of the loading div are not read (by NVDAor jaws) when the loading div is shown.

<div class='loading' aria-live='polite' aria-label='Do not refresh the page' tabindex="-1">Do not refresh the page</div>

I wouldn’t like to change the structure of the application but work around using ‘aria tags’ to resolve this, just wondering if I will have to do anything more to make aria-live work?

Updated (27/July/2016)

Further clarification: I am not removing the content from DOM but using css to show/hide content (display: none to display: block and vice versa)

How to solve :

I know you bored from this bug, So we are here to help you! Take a deep breath and look at the explanation of your problem. We have many solutions to this problem, But we recommend you to use the first method because it is tested & true method that will 100% work for you.

Method 1

aria-live triggers screen readers when an element with aria-live (or text within an element with aria-live) is added or removed from the DOM. In contrast, when you unhide a hidden element, neither elements nor text are added or removed from the DOM, so the element’s aria-live property doesn’t come into play.

To get screen readers to announce “Do not refresh the page”, either of these options should do the trick:

  • You can create the <div class='loading' aria-live='polite'> element and its text content from scratch and then add that element to the DOM.
  • Or you can start with an empty <div class='loading' aria-live='polite'> element and then populate its text content.

A few other tidbits:

  • As long as the text inside the element is what you want to be read aloud, you can omit the element’s aria-label='Do not refresh the page' attribute.
  • For icing on the cake, it can’t hurt to include a role attribute on the div that has aria-live. If you’re not sure which role to use, go with role="status"—that’s a pretty safe bet.
  • When or if the page is at a state where you no longer need to display “Do not refresh the page”, be sure to reverse the steps above. (That is, if you went with the first option and you added the whole element to the DOM, remove that entire element from the DOM. Or if you went with the second option and you populated the element’s text content, clear out the element’s text content.)

Method 2

There are several issues with dynamically added or shown/hidden live-region.

Firstly a quote from MDN – ARIA live regions:

Simply including an aria-live attribute or a specialized live region role (such as role="alert") in the initial markup as it’s loaded will have no effect.
Dynamically adding an element with an aria-live attribute or specialized role to the document also won’t result in any announcement by assistive technologies (as, at that point, the browser/assistive technologies are not aware of the live region yet, so cannot monitor it for changes).
Always make sure that the live region is present in the document first, and only then dynamically add/change any content.

From my personal experience, even if a live regoin exists in the DOM on page load if you use show/hide then NVDA also has a bug which requires a small delay before a text update in a live region after it was shown initially. Apparently because the region didn’t exist when the first text was added, so this isn’t an “update”. Regarding the timeout, you’d need to set it to something greater than the browser’s refresh tick. I use 100ms. Disclaimer: I am strongly against such workarounds to make up for the issues with screen readers or browsers but it might be useful for someone in some cases.

Note: Use and implement method 1 because this method fully tested our system.
Thank you 🙂

All methods was sourced from stackoverflow.com or stackexchange.com, is licensed under cc by-sa 2.5, cc by-sa 3.0 and cc by-sa 4.0

Leave a Reply