Element: ariaBrailleLabel 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 ariaBrailleLabel-Eigenschaft des Element-Interfaces spiegelt den Wert des aria-braillelabel-Attributes wider, welches die ARIA-Braille-Beschriftung des Elements definiert.

Diese Elementbeschriftung kann von unterstützenden Technologien verwendet werden, die Inhalte in Braille darstellen können, sollte jedoch nur gesetzt werden, wenn eine spezifische Braille-Beschriftung die Benutzererfahrung verbessern würde. Das aria-braillelabel enthält zusätzliche Informationen darüber, wann die Eigenschaft festgelegt werden sollte.

Wert

<string>: Der Wert ist ein Zeichenfolgenwert, ein unbeschränkter Werttyp, der in Braille umgewandelt werden soll.

Beispiele

Abrufen und Setzen der ariaBrailleLabel

Dieses Beispiel zeigt, wie die ariaBrailleLabel-Eigenschaft abgerufen und gesetzt wird.

HTML

Zuerst definieren wir eine Schaltfläche mit dem Labeltext "3 von 5 Sternen" und einem aria-braillelabel-Attribut mit dem Wert "\*\*\*". Dies ermöglicht, dass eine Braille-Anzeige "btn ***" in Braille anzeigt, anstatt der ausführlicheren Darstellung "btn gra 3 von 5 Sternen".

html

<button id="button" aria-braillelabel="\*\*\*">3 out of 5 stars</button>

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

#log {
  height: 100px;
  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;
}

Der Code verwendet dann die ariaBrailleLabel-Eigenschaft der Schaltfläche, um zuerst das Braille-Label abzurufen und zu protokollieren. Anschließend wird das Braille-Label auf "3*" gesetzt und der Wert erneut protokolliert.

const button = document.getElementById("button");
log(button.ariaBrailleLabel);
button.ariaBrailleLabel = "3*";
log(button.ariaBrailleLabel);

Ergebnis

Spezifikationen

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

Browser-Kompatibilität

BCD tables only load in the browser