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

[Global] Heading structure _may_ be out of order #1457

Open
svinkle opened this issue Mar 7, 2022 · 0 comments
Open

[Global] Heading structure _may_ be out of order #1457

svinkle opened this issue Mar 7, 2022 · 0 comments
Labels
Category: Accessibility Bugs found while using assistive technology Critical Path: 2 Affects some merchants/buyers Effort: Low Severity: 4

Comments

@svinkle
Copy link
Member

svinkle commented Mar 7, 2022

Issue summary

In any section instance which includes h3 headings, heading structure could become out of order if the merchant removes the section "Heading" setting text.

For example, a product detail page with a multicolumn section with no title, the page heading structure includes a primary h1 then subheading h3 for each multicolumn item.

This would lead to a confusing user experience when screen reader user navigate via headings alone.

Screenshots Screenshot of a product page with multicolumn section content. Arrows point out the product title as an h1 heading and each multicolumn title as an h3.

Steps to reproduce

  1. Go to a Studio demo store PDP page with any supported browser
  2. With an active screen reader, navigate by headings alone

Behavior

Expected

  • Section h2 headings to existing the page.

Actual

  • Section h2 headings are missing.

Recommendation

When the merchant removes the section heading text, instead of removing the h2:

  1. Keep the heading h2 in the DOM.
  2. Apply the .visually-hidden class to remove the heading visually
  3. Set the h2 title text as the default text for the section:
    • Featured collection: "Featured collection"
    • Collage: "Multimedia collage"
    • Multicolumn: "Multicolumn"
    • Blog posts: "Blog posts"
    • Collection list: "Collections"

These changes will keep the inteded heading structure intact and inform the user of the section purpose/content type.

- <section>
-- section title (h2)
--- item title (h3)
--- item title (h3)

Recommended code

HTML

<h2
  class="visually-hidden"
  data-live-text-setting="section.template--15459810640040__1643899285fb6b3031.title/escape"
>
  Multicolumn
</h2>

Specifications

  • Dawn version: 3.0
  • Browser: Any
  • Component: Global
  • WCAG Principal: Operable
  • WCAG SC: 2.4.10 Section Headings
  • Severity: Medium
  • Effort: Low
@svinkle svinkle added Severity: 2 High Severity Category: Accessibility Bugs found while using assistive technology Effort: Low Critical Path: 2 Affects some merchants/buyers labels Mar 7, 2022
@kimberlyoleiro kimberlyoleiro added Severity: 4 and removed Severity: 2 High Severity labels May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Accessibility Bugs found while using assistive technology Critical Path: 2 Affects some merchants/buyers Effort: Low Severity: 4
Projects
None yet
Development

No branches or pull requests

2 participants