Skip to content

Commit

Permalink
Merge pull request #2806 from department-of-veterans-affairs/a11y-but…
Browse files Browse the repository at this point in the history
…ton-description

Update button guidance for new description prop
  • Loading branch information
rsmithadhoc committed May 13, 2024
2 parents f9f82b6 + 8971da8 commit 4f3d8fb
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/_components/button/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,13 @@ That guidance agrees with [Apple's Human Interface Guidelines](https://developer
* **Use at least [1 spacing unit]({{ site.baseurl }}/foundation/spacing-units) separating tappable elements.**

* **Prioritize a clear and concise button label and only use `message-aria-describedby` when it enhances understanding and accessibility.** The `message-aria-describedby` property emulates HTML's `aria-describedby` due to web component limitations. It allows adding an additional description that is visually hidden, but screen reader accessible.
* When to use:
* **Providing additional context or instructions.** If the button label is concise but requires further explanation.
* When _not_ to use:
* **Duplicating information.** If the button's label is clear and concise, adding additional information may be redundant and cumbersome for users of assistive technology.
* **Providing essential information.** Crucial information for the button's purpose should be the button label itself, _not_ solely relying on an additional description.

{% include content/links-vs-buttons.md %}

{% include a11y/do-not-disable-buttons.md %}
Expand Down

0 comments on commit 4f3d8fb

Please sign in to comment.