Element: ariaBrailleRoleDescription-Eigenschaft

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.

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

Diese Eigenschaft kann verwendet werden, um eine abgekürzte Version des aria-roledescription-Wertes bereitzustellen. Sie sollte nur verwendet werden, wenn aria-roledescription vorhanden ist und in dem seltenen Fall, dass es für Braille zu wortreich ist. Das aria-brailleroledescription-Attribut enthält zusätzliche Informationen darüber, wann die Eigenschaft gesetzt werden sollte.

Wert

<string>: Der Wert ist eine Zeichenkette, ein uneingeschränkter Wertetyp, der in Braille umgewandelt werden soll.

Beispiele

Abrufen und Festlegen von ariaBrailleRoleDescription

Dieses Beispiel zeigt, wie Sie die ariaBrailleRoleDescription-Eigenschaft abrufen und festlegen können.

HTML

Zuerst definieren wir ein <article>-Element, das als Folie in einer Diashow verwendet wird. Wir setzen das aria-roledescription-Attribut auf "Slide", und die dazugehörige Braille-Kurzform in aria-brailleroledescription auf "sld".

html

<article
  id="article"
  aria-roledescription="slide"
  aria-brailleroledescription="sld"
  aria-labelledby="slide1heading">
  <h1 id="slide1heading">Welcome to my talk</h1>
</article>

<pre id="log"></pre>

#log {
  height: 70px;
  overflow: scroll;
  padding: 0.5rem;
  border: 1px solid black;
}

JavaScript

const logElement = document.querySelector("#log");
function log(text) {
  logElement.innerText = `${logElement.innerText}${text}\n`;
  logElement.scrollTop = logElement.scrollHeight;
}

Um die Rollenbeschreibung des Elements abzurufen, verwenden wir die ariaBrailleRoleDescription-Eigenschaft. Der untenstehende Code ruft zuerst den Wert ab und protokolliert ihn. Er setzt dann die Braille-Rollenbeschreibung auf "sd" und protokolliert den Wert erneut (nur zur Veranschaulichung — im produktiven Code würden Sie diesen Wert nicht setzen).

const article = document.getElementById("article");
log(article.ariaBrailleRoleDescription);
article.ariaBrailleRoleDescription = "sd";
log(article.ariaBrailleRoleDescription);

Ergebnis

Spezifikationen

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

Browser-Kompatibilität

BCD tables only load in the browser