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 der Element-Schnittstelle spiegelt den Wert des aria-braillelabel-Attributs wider, welches das ARIA-Brailleschrift-Label des Elements definiert.

Dieses Element-Label kann von unterstützenden Technologien, die Inhalte in Brailleschrift darstellen können, verwendet werden, sollte jedoch nur gesetzt werden, wenn ein spezifisches Braille-Label das Benutzererlebnis verbessern würde. Das aria-braillelabel enthält zusätzliche Informationen darüber, wann die Eigenschaft gesetzt werden sollte.

Wert

<string>: Der Wert ist ein String, ein uneingeschränkter Werttyp, der in Brailleschrift umgewandelt werden soll.

Beispiele

Abrufen und Setzen von ariaBrailleLabel

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

HTML

Zuerst definieren wir eine Schaltfläche mit dem Beschriftungstext "3 von 5 Sternen" und einem aria-braillelabel-Attribut mit dem Wert "\*\*\*". Dies ermöglicht es einer Braille-Anzeige, "btn ***" in Brailleschrift anzuzeigen, anstatt des ausführlicheren "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 das Braille-Label zunächst 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