ElementInternals.ariaHidden
The ariaHidden
property of the ElementInternals
interface reflects the value of the aria-hidden
attribute, which indicates whether the element is exposed to an accessibility API.
Note: Setting aria attributes on ElementInternals
allows default semantics to be defined on a custom element. These may be overwritten by author-defined attributes, but ensure that default semantics are retained should the author delete those attributes, or fail to add them at all. For more information see the Accessibility Object Model explainer.
Syntax
let ariaHidden = ElementInternals.ariaHidden; ElementInternals.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 value of ariaHidden
is set to "true".
this.internals_.ariaHidden = "true";
Specifications
Specification |
---|
Accessible Rich Internet Applications (WAI-ARIA) 1.2 (WAI-ARIA 1.2) # dom-ariamixin-ariahidden |
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 | |
ariaHidden |
81 |
81 |
No |
No |
68 |
No |
81 |
81 |
No |
58 |
No |
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/ElementInternals/ariaHidden