OpenA11y Evaluation Library

aria-brailleroledescription abbreviated role description.

Rule ID Widget 18
Conformance Required
Definition Use aria-brailleroledescription attribute to provide an abbreviated description of a role for Braille rendering.
Purpose
  • The aria-brailleroledescription property gives authors the ability to override how assistive technologies localize and describe the role of an element in Braille.
  • Authors should limit use of aria-brailleroledescription to instances where the a Braille description improves understanding of the role.
Conformance Required
WCAG Success Criteria

Success Criterion 2.4.6 Headings and Labels

Other Related Success Criterion:

Rule Category ARIA Widgets
Rule Scope Element
First Step no
aXe Rules
Wave Rules
Techniques
  • aria-brailleroledescription should only be used by experienced Braille readers or in close consultation with experienced Braille readers.
  • The element to which aria-brailleroledescription is applied has a valid WAI-ARIA role.
  • The value of aria-brailleroledescription is not empty or does not contain only whitespace characters.
  • The value of aria-brailleroledescription does not contain any characters in Unicode Braille Patterns or consists of only characters in Unicode Braille Patterns; the value does not only contain Braille Pattern dots-0.
  • The value of aria-brailleroledescription is not identical to the element's aria-roledescription or role .
  • Important to test the aria-brailleroledescription with users to verify it improves the user experience.
Information Links