govau/design-system-components

Accordion wrap toggle button in a heading level

Open

#867 opened on Aug 7, 2019

View on GitHub
 (5 comments) (2 reactions) (0 assignees)HTML (741 stars) (115 forks)batch import
accessibilitygood first issuemodule: accordion

Description

For consideration:

Headings (hx) should be used to wrap the accordion triggering button. This would align with the recommendations of the ARIA 1.1 Practices Guide. The heading level as the first element in the <section>s will also align to the recommendations for the <section> element in the HTML 5.1 W3C Recommendation.

Accordion (Sections With Show/Hide Functionality) https://www.w3.org/TR/wai-aria-practices-1.1/#accordion

The section element https://www.w3.org/TR/2016/REC-html51-20161101/sections.html#the-section-element

<section class="au-accordion"> <h3> <button class="au-accordion__title js-au-accordion" aria-controls="accordion-default" aria-expanded="true" onclick="return AU.accordion.Toggle( this )"> Accordion title </button> </h3> <div class="au-accordion__body" id="accordion-default"> <div class="au-accordion__body-wrapper"> Here <a href="#url">is</a> some accordion content </div> </div> </section>

Contributor guide

Tech stack
htmlcssjavascript
Domain
frontend
Issue type
accessibility
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Locate the accordion component template in the repository (likely in components/accordion). The current structure has a button directly inside a section. Modify the template to wrap the button in an appropriate heading level (e.g., h3). Ensure the heading is the first element inside the section. Also update any associated CSS or JavaScript if needed to maintain styling. Refer to the WAI ARIA practices link for correct markup.