Element.ariaRoleDescription
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.
Syntax
var ariaRoleDescription = element.ariaRoleDescription; element.ariaRoleDescription = ariaRoleDescription
Value
A DOMString
.
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.
<div id="myApplication" role="application" aria-roledescription="a description of this widget">...</div>
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 | Status | Comment |
---|---|---|
Accessible Rich Internet Applications (WAI-ARIA) 1.2 The definition of 'ariaRoleDescription' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
BCD tables only load in the browser