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

WIP: docs(component): adds the progress bar component to documentation site #379

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

johnnolan
Copy link
Contributor

@johnnolan johnnolan commented Oct 11, 2022

Description of the change

Adds documentation for the Progress Bar component to the pattern library documentation site.

Before merging this we require the following.

  • Responsive Design adding and testing
  • Accessibility Audit completed on this ticket

Release notes

Adds documentation for the Progress Bar component to the pattern library documentation site.

image

@johnnolan johnnolan added the docs Change to documentation label Oct 11, 2022
@johnnolan johnnolan requested a review from a team as a code owner October 11, 2022 08:52
@gregtyler
Copy link
Contributor

Two thoughts:

@gregtyler
Copy link
Contributor

We should probably also check how this works with small screens or long lists. The CSS doesn't seem to make specific accommodations and I expect it will need some.

Identifies that this component does not have accessibility or responsive design built
@johnnolan johnnolan changed the title docs(component): adds the progress bar component to documentation site WIP: docs(component): adds the progress bar component to documentation site Oct 11, 2022
@johnnolan johnnolan marked this pull request as draft October 11, 2022 09:22
@gregtyler
Copy link
Contributor

Couple of screenshots of responsiveness on small screens:

image image

@DanGuyMOJ
Copy link

Couple of screenshots of responsiveness on small screens:

image image

Should this switch to a vertical orientation on small screens?

@andyronksleymoj
Copy link

Accessibility team has reviewed this. Current findings and open questions are captured in this Google Doc. Let me know if you cannot access this and I will check the sharing settings.

@andyronksleymoj
Copy link

From a technical/code point of view, the main issue at present is the completed state visually shown by the filled green circle and tick icon is not conveyed to a screen reader (as the visual affordances are just CSS and SVG images). There are a number of ways of addressing this but we think the best approach would be to add visually hidden text. The markup would look something along the lines of this:

<h2 class="vh">Progress of application</h2>
<ol>
  <li>Your details <span class="vh"> complete</span></li>
  <li>Address <span class="vh"> complete</span></li>
  <li>Passport details <span class="vh"> not started</span></li>
  <li>Review <span class="vh"> not started</span></li>
  <li>Application complete <span class="vh"> not started</span></li>
</ol>

I understand the "vh" CSS class is something that can be used from the GOV.UK design system.

Side note: "Application complete" might be a confusing if that is just a summary screen and not a step that requires user input. If it's just a summary, potentially it shouldn't be shown as a step in the progress bar. That's a question for discussion!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Change to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants