Element.ariaHidden
The ariaHidden
property of the Element
interface reflects the value of the aria-hidden
attribute, which indicates whether the element is exposed to an accessibility API.
Syntax
var ariaHidden = element.ariaHidden; element.ariaHidden = ariaHidden
Value
A DOMString
with one of the following values:
"true"
- The element is hidden from the accessibility API.
"false"
- The element is exposed to the accessibility API as if it were rendered.
undefined
- The element's hidden state is determined by the user agent based on whether it is rendered.
Examples
In this example the aria-hidden
attribute on the element with an ID of hidden
is set to "true". Using ariaHidden
we update the value to "false".
<div id="hidden" aria-hidden="true">Some things are better left unsaid.</div>
let el = document.getElementById('hidden');
console.log(el.ariaHidden); // true
el.ariaHidden = "false"
console.log(el.ariaHidden); // false
Specifications
Specification | Status | Comment |
---|---|---|
Accessible Rich Internet Applications (WAI-ARIA) 1.2 The definition of 'ariaHidden' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
BCD tables only load in the browser