ElementInternals: ariaBrailleRoleDescription-Eigenschaft

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.

Die ariaBrailleRoleDescription-Eigenschaft der ElementInternals-Schnittstelle spiegelt den Wert des aria-brailleroledescription-Attributs wider, welches die ARIA-Braillerollenbeschreibung des Elements definiert.

Diese Eigenschaft kann verwendet werden, um eine verkürzte Version des aria-roledescription-Wertes bereitzustellen. Sie sollte nur verwendet werden, wenn aria-roledescription vorhanden ist und in seltenen Fällen, in denen diese für Braille zu ausführlich ist. Das aria-brailleroledescription enthält zusätzliche Informationen darüber, wann die Eigenschaft gesetzt werden sollte.

Wert

Ein String, der in Braille umgewandelt werden soll.

Beispiele

Angenommen, wir haben ein benutzerdefiniertes Slide-Element:

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

  // …
}

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

Wir können den Wert der aria-brailleroledescription-Eigenschaft des benutzerdefinierten Elements abrufen und setzen:

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

Ergebnis

Spezifikationen

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

Browser-Kompatibilität

Siehe auch