Skip to content

Commit

Permalink
Aria-live changes for #44
Browse files Browse the repository at this point in the history 
#44
  • Loading branch information
@jnurthen
jnurthen committed Jul 1, 2016
1 parent 20cfaa5 commit dafdb73
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions aria-practices.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4145,11 +4145,11 @@ <h4> Live Region Properties and How to Use Them</h4>
<h3> Choosing Between Special Case Live Regions</h3>
<p>You may wish to use a special live region role instead of applying live region properties. WAI-ARIA contains a number of standard roles which are by default considered "live" sections of your Web page. It is important to know when to use these and when to create a custom live region on your known. Here are some rules of thumb:</p>
<blockquote>
<p><a class="role-reference" href="#alert">alert</a> - You must use the <a class="role-reference" href="#alert">alert</a> role for a one-time notification which shows for a period of time and goes away and is intended to alert the user that something has happened. The assistive technology should be notified by the user agent that an alert has occurred, if your operating system supports this type of event notification. When choosing to use alert you should use the <a class="role-reference" href="#alertdialog">alertdialog</a> role instead if something inside the alert is to receive focus. Both <a class="role-reference" href="#alert">alert</a> and <a class="role-reference" href="#alertdialog">alertdialog</a> appear to pop-up to the user to get their attention.</p>
<p><a class="role-reference" href="#status">status</a> - You must use the <a class="role-reference" href="#status">status</a> role when you want to mark an area which is updated periodically and provides general status of your Web application. Changes in status are not typically announced automatically by an assistive technology. However, it is possible to configure some assistive technologies, such as a scriptable screen reader, to watch for changes in the status bar and announce them. Using the status role is also important in that the user could always check the status section for changes in status on different Web pages. Many applications provide status widgets and they are often found, visibly, at the bottom of the application and contain a variety of widgets within it to convey status. The use of <a class="role-reference" href="#status">status</a> does not guarantee how the AT will respond to changes in the status. The author can still put live="off" or live="assertive" to influence the ATs treatment of the status. </p>
<p><a class="role-reference" href="#timer">timer</a> - You must use a timer role when you want to mark an area which indicates an amount of elapsed time from a start point, or the time remaining until an end point. The text encapsulated within the timer indicates the current time measurement, and are updated as that amount changes. However, the timer value is not necessarily machine parsable. The text contents <strong>MUST</strong> be updated at fixed intervals, except when the timer is paused or reaches an end-point. </p>
<p><a class="role-reference" href="#marquee">marquee</a>- You must use a marquee role when you need to mark an area with scrolling text such as a stock ticker. The latest text of the scrolled area must be available in the DOM. A marquee behaves like a <a href="#liveprops">live region</a>, with an assumed default <a class="property-reference" href="#aria-live">aria-live</a> property value of "polite."</p>
<p><a class="role-reference" href="#log">log</a> - You must use log if you have a live area where new information is added, like a scrolling chat log of text. Unlike other regions, implied semantics indicate the arrival of new items and the reading order. The log contains a meaningful sequence and new information is added only to the end of the log, not at arbitrary points. If you have a chat text entry area you should indicate that it also controls the aria log aria like so:</p>
<p><a class="role-reference" href="#alert">alert</a> - You may use the <a class="role-reference" href="#alert">alert</a> role for a one-time notification which shows for a period of time and then goes away. It is intended to alert the user that something has happened. The assistive technology should be notified by the user agent that an alert has occurred, if your operating system supports this type of event notification. When choosing to use alert you should use the <a class="role-reference" href="#alertdialog">alertdialog</a> role instead if something inside the alert is to receive focus. Both <a class="role-reference" href="#alert">alert</a> and <a class="role-reference" href="#alertdialog">alertdialog</a> usually appear to pop-up to the user to get their attention. Unless specified otherwise an alert region has an implicit <a class="property-reference" href="#aria-live">aria-live</a> of "assertive" and <a class="property-reference" href="#aria-atomic">aria-atomic</a> of "true".</p>
<p><a class="role-reference" href="#status">status</a> - You may use the <a class="role-reference" href="#status">status</a> role when you want to mark an area which is updated periodically and provides a general status of your Web application. Many applications provide status widgets and they are often found, visibly, at the bottom of the application and contain a variety of widgets within it to convey status. Unless specified otherwise a status region has an implicit <a class="property-reference" href="#aria-live">aria-live</a> of "polite" and <a class="property-reference" href="#aria-atomic">aria-atomic</a> of "true". </p>
<p><a class="role-reference" href="#timer">timer</a> - You may use a timer role when you want to mark an area which indicates an amount of elapsed time from a start point, or the time remaining until an end point. The text encapsulated within the timer indicates the current time measurement, and is updated as that amount changes. However, the timer value is not necessarily machine parsable. The text contents <strong>MUST</strong> be updated at fixed intervals, except when the timer is paused or reaches an end-point. The timer role has an impicit <a class="property-reference" href="#aria-live">aria-live</a> of "off". </p>
<p><a class="role-reference" href="#marquee">marquee</a>- You may use a marquee role when you need to mark an area with scrolling text such as a stock ticker. The latest text of the scrolled area must be available in the DOM. A marquee behaves like a <a href="#liveprops">live region</a>, with an implicit <a class="property-reference" href="#aria-live">aria-live</a> property value of "off."</p>
<p><a class="role-reference" href="#log">log</a> - You may use log if you have a live area where new information is added, like a scrolling chat log of text. Unlike other regions, implied semantics indicate the arrival of new items and the reading order. The log contains a meaningful sequence and new information is added only to the end of the log, not at arbitrary points. Log has an implicit <a class="property-reference" href="#aria-live">aria-live</a> of "polite"If you have a chat text entry area you should indicate that it also controls the aria log aria like so:</p>
<pre class="example highlight">&lt;div contenteditable="true" role="log" id="chatlog"&gt;
&lt;/div&gt;

Expand All @@ -4160,7 +4160,7 @@ <h3> Choosing Between Special Case Live Regions</h3>
contenteditable="true"
aria-labelledby="gettext"&gt;
&lt;/div</pre>
<p><a href="#attrs_liveregions" class="specref">live region</a> - If you have some other live area use case, WAI-ARIA allows you to mark an area using the <a class="property-reference" href="#aria-live">aria-live</a> attribute. This accompanied by the collection of attributes which support the live property allow you to create your own custom live area on your Web page. For more details regarding live regions refer to the <a href="#LiveRegions">live region</a> section of this guide.</p>
<p><a href="#attrs_liveregions" class="specref">live region</a> - If you have some other live area use case, WAI-ARIA allows you to mark an area using the <a class="property-reference" href="#aria-live">aria-live</a> attribute. This, accompanied by the collection of attributes which support the live property, allows you to create your own custom live area on your Web page. For more details regarding live regions refer to the <a href="#LiveRegions">live region</a> section of this guide.</p>
</blockquote>
<p>Live region roles that are applied to elements having strong native semantics are not mapped consistently to the platform accessibility API. An example is the <code>TABLE</code> element. It is recommended that authors apply live regions to <code>DIV</code> and <code>SPAN</code> containers. For example: </p>
<pre class="example highlight">&lt;!-- Live region 'log' role used with TABLE element: the 'log' role is not consistently mapped to platform AAPI. --&gt;
Expand Down

0 comments on commit dafdb73

Please sign in to comment.