Skip to content
This repository is currently being migrated. It's locked while the migration is in progress.

Update va-telephone accessibility guidance for mesasageAriaDescribedby prop usage#6123

Open
RyanMunsch wants to merge 6 commits into
mainfrom
va-tel-ariadescribedby-guidance
Open

Update va-telephone accessibility guidance for mesasageAriaDescribedby prop usage#6123
RyanMunsch wants to merge 6 commits into
mainfrom
va-tel-ariadescribedby-guidance

Conversation

@RyanMunsch
Copy link
Copy Markdown
Contributor

@RyanMunsch RyanMunsch commented Apr 13, 2026

Summary

This PR updates the guidance for the va-telephone component regarding best practices for use of the messageAriaDescribedby prop - guiding teams to not pass a value that matches the text content of the sibling element that serves as a label for the component.

Related Issue

Closes #6099

Preview Environment Links

Open Preview Environment

Add item to guide usage of `messageAriaDescribedby` prop to not use same text value of contextual sibling element.
@RyanMunsch RyanMunsch requested a review from a team as a code owner April 13, 2026 19:44
Copilot AI review requested due to automatic review settings April 13, 2026 19:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the va-telephone component documentation to clarify accessibility best practices around messageAriaDescribedby, aiming to prevent redundant screen reader announcements.

Changes:

  • Fixes formatting/indentation in the accessibility bullet list.
  • Adds guidance discouraging messageAriaDescribedby usage when sibling context/label text would be redundantly announced.

Comment thread src/_components/telephone.md Outdated
Comment thread src/_components/telephone.md Outdated
Comment thread src/_components/telephone.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Collaborator

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking good! I added a comment with a few suggestions for tweaks. Let me know if you have questions!

Comment thread src/_components/telephone.md Outdated
Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@jeana-adhoc jeana-adhoc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

va-telephone: Update guidance regarding use of messageAriaDescribedby prop

4 participants