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

WelcomeMessage header text marked as heading #2373

Merged
merged 4 commits into from
Jul 10, 2023

Conversation

piwysocki
Copy link
Contributor

Changes

role="heading" attribute and aria-level="1" attribute added to WelcomeMessage heading.

It adds heading semantics to markup without the risk of breaking any styles.

References

This change resolves an issue in accessibility.
Header name and title appears to be heading for section of content, but is not marked as heading for screen reader users.

Testing

  • This change adds unit test coverage
  • This change adds integration test coverage
  • This change has been tested on the latest version of the platform/language

Checklist

@piwysocki piwysocki requested a review from a team as a code owner June 29, 2023 12:29
@frederikprijck
Copy link
Member

Thanks for the PR, can you elaborate which tool showed this as an a11y issue to try and understand what's happening and how a welcome message is treated as a heading?

Thanks

@frederikprijck frederikprijck added the needs more info This issue is waiting for a response from the issue or PR author label Jun 29, 2023
@pbuckleyfen
Copy link

Hey, as outlined in rule 1.3.1.e Headings - Text that acts as a heading visually or structurally MUST be designated as a true heading in the markup.

The Welcome message visually acts as the main element heading on the login screen.

Providing a heading element will aid screen reader users to understand the structure of the content

@piwysocki
Copy link
Contributor Author

More info provided above

@frederikprijck
Copy link
Member

Thanks for this change, looks legit and definetly want to look into adding this.

Has this been tester with a certain screenreader?

@piwysocki
Copy link
Contributor Author

Yes, tested with NVDA.

Before and after:
obraz

@frederikprijck frederikprijck added enhancement An enhancement or improvement to the SDK that could not be otherwise categorized as a new feature and removed needs more info This issue is waiting for a response from the issue or PR author labels Jul 7, 2023
@stevehobbsdev stevehobbsdev merged commit 6ff9f7d into auth0:master Jul 10, 2023
@stevehobbsdev
Copy link
Contributor

Thanks for your contribution here @piwysocki ! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An enhancement or improvement to the SDK that could not be otherwise categorized as a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants