Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

USWDS-Site - Feature: Update guidance for table component caption #3100

Open
2 tasks done
amycole501 opened this issue Feb 11, 2025 · 1 comment
Open
2 tasks done
Labels
Affects: Accessibility 🟡 Relates to the accessibility of our components Is: New Guidance A feature request for new guidance Type: Feature Request New functionality

Comments

@amycole501
Copy link

amycole501 commented Feb 11, 2025

Is your feature request related to a problem? Please describe.

Related to #6253 and #489

We should update the guidance on the table page to specify the importance of the caption element and its relationship to a table. It serves as the title of the table and we should encourage people to use the element in almost all cases.

Current guidance on our table page:

Add title and attribution in a caption. When adding a title, attribution, or a last-updated date to a table, include it in the tag inside of the

element.

Describe the solution you'd like

Draft proposed change:

Use a caption to describe the purpose of the table. When adding a title, attribution, or a last-updated date to a table, include it in the

tag inside of the table element. Keep the caption wording short.

Ensure sighted users are able to identify the caption as the title of the table. Make the caption style larger than the body style of the table text. Do not match an existing heading level or other style (such as an H2 or H3). Caption styles should be noticeable yet distinct.

Describe alternatives you've considered

No response

Additional context

Related research

Code of Conduct

@amycole501 amycole501 added Affects: Accessibility 🟡 Relates to the accessibility of our components Is: New Guidance A feature request for new guidance Type: Feature Request New functionality labels Feb 11, 2025
@dct2023
Copy link

dct2023 commented Feb 13, 2025

@amycole501 to share the draft version to have a full scope of this request.

cc: @mejiaj @amyleadem

@dct2023 dct2023 moved this from Triage to Backlog in USWDS Core Project Data Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects: Accessibility 🟡 Relates to the accessibility of our components Is: New Guidance A feature request for new guidance Type: Feature Request New functionality
Projects
Status: Backlog
Development

No branches or pull requests

2 participants