The HTML aria-description attribute
The aria-description attribute gives an element an accessible description directly from a string, the string counterpart to aria-describedby. It is part of ARIA 1.3 and support is still limited.
Overview
The aria-description attribute provides an accessible description from a string (ARIA 1.3).
It is one of ARIA's naming and description properties, which give an element an accessible name or description for assistive technology. Whenever you can, associate visible text (a <label>, or aria-labelledby pointing at on-screen text) so sighted and screen-reader users get the same information, rather than hiding it in an invisible string.
Like all ARIA, aria-description changes only the accessibility tree (what assistive technology perceives), never the element's behavior or appearance. The first rule of ARIA applies: if a native HTML element or attribute conveys this, use that instead, and only reach for ARIA when nothing native fits.
Syntax
<button aria-description="Opens in a new window">Docs</button>Values
| Value |
|---|
| A string. |
Example
<a href="/report.pdf" aria-description="PDF, 2.3 MB">Download report</a>Best practices
- Follow the first rule of ARIA: use a native HTML element or attribute that conveys this where one exists, rather than adding ARIA.
- Prefer referencing visible text (a <label> or aria-labelledby) over an invisible string where possible.
- Use aria-label only when there is no suitable on-screen text to reference.
- Keep the name concise and meaningful; it is exactly what a screen reader announces.