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.

Sign up for GitHub

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

Jump to bottom

Accordion HTML version doesn't state that IDs need to be unique #1073

Closed
Tracked by #3574
hannalaakso opened this issue Oct 30, 2019 · 2 comments · Fixed by #3789
Closed
Tracked by #3574

Accordion HTML version doesn't state that IDs need to be unique #1073

hannalaakso opened this issue Oct 30, 2019 · 2 comments · Fixed by #3789
Assignees
@patrickpatrickpatrick
Labels
accordion documentation User requests new documentation or improvements to existing documentation

Comments

@hannalaakso
Copy link
Member

hannalaakso commented Oct 30, 2019 •
edited

Nunjucks options table for the accordion states this for IDs:

Must be unique across the domain of your service (as the expanded state of individual instances of the component persists across page loads using localStorage).

However if you look at the HTML version this is not stated.

A user ran into an issue where they didn't know the IDs for accordions needed to be unique. I'm raising this retrospectively from the support logs and don't know if they were using the HTML version or macro but the issue could have been the lack of HTML docs.

Wider issue

There might be wider issues around how how we represent the ways of customising the component markup for HTML users as they aren't as clearly signposted as the Nunjucks ones
@NickColley NickColley added Priority: low documentation User requests new documentation or improvements to existing documentation and removed awaiting triage Needs triaging by team labels Oct 30, 2019
@hannalaakso
Copy link
Member Author

hannalaakso commented Oct 30, 2019 •
edited

Discussed with team in triage. We've not seen the wider issue come up with users so we'll keep an eye on it. We're going to document the requirement in the guidance.

For context, here is the original discussion about putting the onus on the team implementing this to make the IDs unique across the domain and only documenting this in the options table.

@hannalaakso
Copy link
Member Author

This would be solved by #1085

@36degrees 36degrees mentioned this issue Jan 7, 2021
Closed
@36degrees 36degrees mentioned this issue Feb 22, 2024
Open
@patrickpatrickpatrick patrickpatrickpatrick self-assigned this May 8, 2024
patrickpatrickpatrick added a commit that referenced this issue May 9, 2024
@patrickpatrickpatrick
Add documentation for 'id' to accordion component
467b689 
The extra documentation for the 'id' attribute that was present in the
Nunjucks options table for the accordion has been added to the 'How It
Works Section'. This is because if a user is just using the HTML of the
accordion component, then they might not encounter the additional
documentation provided for the 'id' attribute.

This addresses issue #1073.
Merged
@patrickpatrickpatrick patrickpatrickpatrick linked a pull request May 9, 2024 that will close this issue
Add documentation for 'id' to accordion component #3789
Merged
patrickpatrickpatrick added a commit that referenced this issue May 14, 2024
@patrickpatrickpatrick
Add documentation for 'id' to accordion component
e7ac344 
The extra documentation for the 'id' attribute that was present in the
Nunjucks options table for the accordion has been added to the 'How It
Works Section'. This is because if a user is just using the HTML of the
accordion component, then they might not encounter the additional
documentation provided for the 'id' attribute.

This addresses issue #1073.
patrickpatrickpatrick added a commit that referenced this issue May 14, 2024
@patrickpatrickpatrick
Add documentation for 'id' to accordion component
bd29713 
The extra documentation for the 'id' attribute that was present in the
Nunjucks options table for the accordion has been added to the 'How It
Works Section'. This is because if a user is just using the HTML of the
accordion component, then they might not encounter the additional
documentation provided for the 'id' attribute.

This addresses issue #1073.
patrickpatrickpatrick added a commit that referenced this issue May 15, 2024
@patrickpatrickpatrick
Add documentation for 'id' to accordion component
e01cb50 
The extra documentation for the 'id' attribute that was present in the
Nunjucks options table for the accordion has been added to the 'How It
Works Section'. This is because if a user is just using the HTML of the
accordion component, then they might not encounter the additional
documentation provided for the 'id' attribute.

This addresses issue #1073.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@patrickpatrickpatrick patrickpatrickpatrick

Labels
accordion documentation User requests new documentation or improvements to existing documentation
Projects
GOV.UK Design System cycle board
Status: Done 🏁
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation for 'id' to accordion component alphagov/govuk-design-system
5 participants
@36degrees @NickColley @patrickpatrickpatrick @hannalaakso @kellylee-gds