W3cubDocs

/Web APIs

Element: ariaRoleDescription property

The ariaRoleDescription property of the Element interface reflects the value of the aria-roledescription attribute, which defines a human-readable, author-localized description for the role of an element.

Value

A string.

Examples

In this example the aria-roledescription attribute on the element with an ID of myApplication has been set. Using ariaRoleDescription we can update the value.

html

<div
  id="myApplication"
  role="application"
  aria-roledescription="a description of this widget">
  …
</div>

js

let el = document.getElementById("myApplication");
console.log(el.ariaRoleDescription); // "a description of this widget"
el.ariaRoleDescription = "an updated description of this widget";
console.log(el.ariaRoleDescription); // "an updated description of this widget"

Specifications

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

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
ariaRoleDescription 81 81 119 No 68 12.1 81 81 119 58 12.2 13.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaRoleDescription