ElementInternals: 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 ElementInternals interface reflects the value of the aria-roledescription attribute, which defines a human-readable, author-localized description for the role of an 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.

Value

A string.

Examples

In this example the value of ariaRoleDescription is set to "My custom widget".

class CustomEl extends HTMLElement {
  constructor() {
    super();
    this.internals_ = this.attachInternals();
    this.internals_.ariaRoleDescription = "My custom widget";
  }
  // …
}