Element.ariaLive

The ariaLive property of the Element interface reflects the value of the aria-live attribute, which indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

Syntax

var ariaLive = element.ariaLive;
element.ariaLive = ariaLive

Value

A DOMString with one of the following values:

"assertive"

Indicates that updates to the region have the highest priority and should be presented the user immediately.

"off"

Indicates that updates to the region should not be presented to the user unless the user is currently focused on that region.

"polite"

Indicates that updates to the region should be presented at the next graceful opportunity, such as at the end of speaking the current sentence or when the user pauses typing.

Examples

In this example the aria-live attribute on the element with an ID of planetInfo is set to "polite". We then update the value to "assertive".

<div role="region" id="planetInfo" aria-live="polite">
  <h2 id="planetTitle">No planet selected</h2>
  <p id="planetDescription">Select a planet to view its description</p>
</div>
let el = document.getElementById('planetInfo');
console.log(el.ariaLive); // "polite"
el.ariaLive = "assertive";
console.log(el.ariaLive); // assertive

Specifications

Specification
Accessible Rich Internet Applications (WAI-ARIA) 1.2 (WAI-ARIA 1.2)
# dom-ariamixin-arialive

Browser compatibility

BCD tables only load in the browser