Element: ariaBrailleLabel property
The ariaBrailleLabel
property of the Element
interface reflects the value of the aria-braillelabel
attribute, which defines the ARIA braille label of the element.
This element label may be used by assistive technologies that can present content in braille, but should only be set if a braille-specific label would improve the user experience.
The aria-braillelabel
contains additional information about when the property should be set.
Value
<string>
-
The value is a string, an unconstrained value type, that is intended to be converted into braille.
Examples
Getting and setting ariaBrailleLabel
This example shows how to get and set the ariaBrailleLabel
property.
HTML
First we define a button with label text "3 out of 5 stars" and an aria-braillelabel
attribute with a value of "\*\*\*"
.
This allows a braille display to show "btn ***" in braille rather than the more verbose "btn gra 3 out of 5 stars".
<button id="button" aria-braillelabel="\*\*\*">3 out of 5 stars</button>
JavaScript
The code then uses the button's ariaBrailleLabel
property to first get and log the braille label.
It then sets the braille label to "3*" and logs the value again.
const button = document.getElementById("button");
log(button.ariaBrailleLabel);
button.ariaBrailleLabel = "3*";
log(button.ariaBrailleLabel);
Result
Specifications
Specification |
---|
Accessible Rich Internet Applications (WAI-ARIA) # dom-ariamixin-ariabraillelabel |
Browser compatibility
BCD tables only load in the browser