ElementInternals: ariaBrailleRoleDescription property

Baseline 2024

Newly available

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

The ariaBrailleRoleDescription property of the ElementInternals interface reflects the value of the aria-brailleroledescription attribute, which defines the ARIA braille role description of the element.

This property may be used to provide an abbreviated version of the aria-roledescription value. It should only be used if aria-roledescription is present and in the rare case where it is too verbose for braille. The aria-brailleroledescription contains additional information about when the property should be set.

Value

A string that is intended to be converted into braille.

Examples

Assuming we have a custom slide element:

class CustomSlide extends HTMLElement {
  constructor() {
    super();
    this._internals = this.attachInternals();
    this._internals.role = "slide";
  }

  // …
}

customElements.define("custom-slide", CustomSlide);

We can retrieve and set the value of the custom element's aria-brailleroledescription value:

const customEl = document.querySelector("custom-slide");
log(customEl.ariaBrailleRoleDescription);
customEl.ariaBrailleRoleDescription = "sd";
log(customEl.ariaBrailleRoleDescription);

Result

Specifications

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