ElementInternals.ariaDescription

The ariaDescription property of the ElementInternals interface reflects the value of the aria-description attribute, which defines a string value that describes or annotates the current element.

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 ariaDescription = ElementInternals.ariaDescription;
ElementInternals.ariaDescription = ariaDescription;

Value

A DOMString.

Examples

In this example the value of ariaDescription is set to "A description of this widget".

this.internals_.ariaDescription = "A description of this widget";

Specifications

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

Browser compatibility

BCD tables only load in the browser