vets-who-code-app icon indicating copy to clipboard operation
vets-who-code-app copied to clipboard

Ensure Visual Titles Use Correct Semantic HTML or Roles

Open jeromehardaway opened this issue 11 months ago • 1 comments

Description: We've identified an issue where elements in our application that visually present themselves as titles are not semantically marked up as headings. To adhere to best practices for accessibility and semantic HTML, these elements need to be properly coded. Specifically, elements that look like titles should either be marked up with heading tags (h1 to h6) or, if using non-heading tags (such as div, span, p, etc.), should include a "role" attribute set to "heading". This change is crucial for screen reader users to understand the page structure correctly and navigate our content more effectively.

Action Required:

  • Audit the application to identify all elements that visually appear as titles but are coded with non-heading HTML tags.
  • For each identified element, do one of the following:
    • Change the tag to an appropriate heading tag (h1-h6), ensuring it fits the page's hierarchical structure.
    • If changing the tag is not feasible, add a "role" attribute with the value "heading" to the element and, if necessary, include the "aria-level" attribute to indicate the heading level it represents.
  • Ensure that the modifications do not adversely affect the visual presentation or layout.

Additional Information: To assist with this task, we are offering a free PDF report that details all the elements requiring attention, along with full instructions on how to correct these issues. This report is available upon request and will be sent directly to your email.

Neutral Score Explanation: This ticket is created as a proactive measure to enhance our application's accessibility and semantic structure. The requirement for correct semantic tagging or roles may not have been previously enforced, which might have resulted in these elements being overlooked. Therefore, this task may not be applicable to all elements previously considered as titles but aims to standardize our approach to ensure accessibility and compliance moving forward.

Please prioritize this task as it is fundamental to our commitment to providing an accessible digital environment for all users.

jeromehardaway avatar Mar 17 '24 02:03 jeromehardaway

Hi @jeromehardaway , can you send me the pdf? Thanks.

IngridFuentes avatar Mar 22 '24 20:03 IngridFuentes