Element: ariaRoleDescription property

Baseline 2023

Newly available

Since October 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

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

BCD tables only load in the browser