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

Update breadcrumb documentation to clarify that H1 should not be used on final crumb within multi-step forms #74133

Closed
1 task done
jilladams opened this issue Jan 22, 2024 · 3 comments
Assignees
Labels
design system documentation platform-design-system-team VA.gov platform design system team's tickets

Comments

@jilladams
Copy link
Contributor

To learn more about contributing to the Design System or requesting new components, requesting changes to existing components, and reporting bugs, go here.
https://design.va.gov/about/contributing-to-the-design-system/


Bug Report or Design System update

  • I’ve searched for any related issues and avoided creating a duplicate issue.

What happened

During PACT Act Collab Cycle review it became clear that design system documentation for breadcrumbs could use an explicit statement for how final crumb should work within multi-step forms.

What I expected to happen

Known exceptions to the rule are documented in the DS docs for breadcrumbs.

@humancompanion-usds
Copy link
Collaborator

Alright, I've read through the issues and the slack thread.

@mnorthuis - How is this for an update?

The documentation currently says:

Each breadcrumb segment should match the H1 of the corresponding page. When writing H1s for a page, follow the content styleguide for writing page titles.

I believe that is still accurate because my reading of that is, essentially, the text of each crumb should match the text of an h1 and not be an abbreviation or variation on that title. Perhaps that needs clarifying. So how about I clarify that and add the following to give us:

  • Each breadcrumb segment should match the text of the title (h1) of the corresponding page. Breadcrumb segment text must match the title (h1) text of a corresponding page and not be an abbreviation or variation of that title. When writing H1s for a page, follow the content styleguide for writing page titles.
  • Use the title (h1) of the Introduction page as the text of the final breadcrumb for a multi-step form. On a multi-step form the final crumb is frozen as the title of the Introduction page and should link back to the Introduction page. The breadcrumb works in concert with the Progress bar - Segmented component to provide context for a user is in a process and on the site.

Does that work? Thoughts?

@mnorthuis
Copy link
Contributor

Yes, that works. I think this should also tie into the title tags - Ithe browser title tags would follow the same logic in regards to always matching the title of the introduction page.

@humancompanion-usds
Copy link
Collaborator

Forgot to tag the issue in the PR but this change went out in here: department-of-veterans-affairs/vets-design-system-documentation#2574

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design system documentation platform-design-system-team VA.gov platform design system team's tickets
Projects
None yet
Development

No branches or pull requests

4 participants