ariaRelevant property

Sets or retrieves which changes to a live region are relevant.

 

Syntax

object.setAttribute("ariaRelevant",value);var value = object.getAttribute("ariaRelevant");

Property values

Type: BSTR

A space-delimited list of one or more of the following values:

(additions)

Insertion of nodes into the live region should be considered relevant.

(removals)

Deletion of nodes should be considered relevant.

(text)

Changes to the textual content of existing nodes should be considered relevant.

(all)

Equivalent to additions removals text.

Standards information

• Accessible Rich Internet Applications (WAI-ARIA) 1.0, Section 6.6

Remarks

Used in Roles

No role required.

 

The IHTMLElement5::ariaRelevant setting gives a hint about what types of changes are relevant and should be announced by assistive technology. Any change that is not relevant should be treated as if the region had IHTMLElement5::ariaLive="off" and should not be announced.

The default behavior is equivalent to additions text. Updates are announced only as nodes are added, or as text is added or removed.

Note  For cross-browser compatibility, always use the WAI-ARIA attribute syntax to access and modify ARIA properties, for example object.setAttribute("aria-valuenow", newValue).

 

See also

Accessible Rich Internet Applications (ARIA)

IHTMLElement5::ariaLive