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 - Feature: Improve heading semantics of banner component #5243

Open
2 tasks done
aduth opened this issue Apr 18, 2023 · 0 comments
Open
2 tasks done

USWDS - Feature: Improve heading semantics of banner component #5243

aduth opened this issue Apr 18, 2023 · 0 comments
Labels
Affects: Accessibility 🟡 Relates to the accessibility of our components Needs: Confirmation We need to confirm that this is an issue Package: Banner Role: Dev Development/engineering skills needed Type: Feature Request New functionality

Comments

@aduth
Copy link
Contributor

aduth commented Apr 18, 2023

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

The visual and informational presentation of the banner component's "Official websites use .gov" and "Secure .gov websites use HTTPS" text are such that they could be interpreted as being headings, while in reality there are no special semantics given to these texts beyond "strong" emphasis.

This was identified during a third-party accessibility audit of our site, which uses the standard USWDS banner component markup.

Relevant text from the report:

after activating Here’s how you know, “Official websites use .gov” is not read as a heading.

Describe the solution you'd like

Ultimately our goals are to ensure that our sites are accessible, while deferring to U.S. Web Design System to provide accessible defaults. We would like to avoid diverging from the given implementation, as this would create a disjointed user experience across government sites, as well as a burdensome developer experience to maintain the separate implementation.

A solution may be one of:

  1. Confirm that the current markup is sufficiently accessible as-is
  2. Or, update banner component code to assign semantics matching the content hierarchy

Additional context

Current component code reference: https://designsystem.digital.gov/components/banner/#component-code

Example relevant segment of code:

<p>
  <strong>Official websites use .gov</strong><br />A
  <strong>.gov</strong> website belongs to an official government
  organization in the United States.
</p>

The expectation from the reporter may be that the <strong> tag used for "Official websites use .gov" should instead be a heading, e.g. h2.

Code of Conduct

@aduth aduth added Status: Triage We're triaging this issue and grooming if necessary Type: Feature Request New functionality labels Apr 18, 2023
@amyleadem amyleadem added Affects: Accessibility 🟡 Relates to the accessibility of our components Package: Banner Needs: Confirmation We need to confirm that this is an issue Role: Dev Development/engineering skills needed and removed Status: Triage We're triaging this issue and grooming if necessary labels Aug 10, 2023
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 Needs: Confirmation We need to confirm that this is an issue Package: Banner Role: Dev Development/engineering skills needed Type: Feature Request New functionality
Projects
Status: Needs refinement
Development

No branches or pull requests

2 participants