Element.ariaAtomic
The ariaAtomic
property of the Element
interface reflects the value of the aria-atomic
attribute, which indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant
attribute.
Syntax
var ariaAtomic = element.ariaAtomic; element.ariaAtomic = ariaAtomic
Value
A DOMString
with one of the following values:
"false"
-
Assistive technologies will present only the changed node or nodes.
"true"
-
Assistive technologies will present the entire changed region as a whole, including the author-defined label if one exists.
Examples
In this example the aria-atomic
attribute on the element with an ID of "clock"
is set to "true". Using ariaAtomic
we update the value to "false".
<div id="clock" role="timer" aria-live="polite" aria-atomic="true"></div>
let el = document.getElementById('clock'); console.log(el.ariaAtomic); // true el.ariaAtomic = "false" console.log(el.ariaAtomic); // false
Specifications
Specification |
---|
Accessible Rich Internet Applications (WAI-ARIA) 1.2 (WAI-ARIA 1.2) # dom-ariamixin-ariaatomic |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
ariaAtomic |
81 |
81 |
No |
No |
68 |
12.1 |
81 |
81 |
No |
58 |
12.2 |
13.0 |
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaAtomic