Skip to content

Breadcrumbs should use the page's H1 #16464

Open
@RLHecht

Description

@RLHecht

Description

In VA.gov, content guidance has been updated such that the final breadcrumb should match the H1.

Current breadcrumb behavior

For any page without left sidebar, the breadcrumb uses H1 (we think - there may be exceptions?).
For any page with a sidebar, the breadcrumb is built based on the menu item, per https://prod.cms.va.gov/admin/structure/cm_document/note/126/breadcrumbs:

  • Easy Breadcrumb does the handling for nodes with no menu. It has all the settings for breadcrumb generation at the link provided. Because the primary vehicle for populating breadcrumbs, the menu_breadcrumbs module, is not configured for all content types the easy_breadcrumb module has been added. The easy_breadcrumb module fills in the gap left by menu_breadcrumbs by populating breadcrumbs based on path for content types without breadcrumb data.
  • Computed Breadcrumb is the other module we added. It doesn't have any configurable settings, but it takes the breadcrumbs generated for any node (whether easy breadcrumb or menu-managed) and shoves them into a hidden field. That field data is what shows up in JSON:API

Desired behavior

We should be consistent with the standard breadcrumb component in the design system, which states:

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.

Example

Example Benefit Detail Page that demonstrates the Left Sidebar effect:
e.g. https://www.va.gov/health-care/how-to-apply/

  • Left nav item = Family health benefits
  • H1 = Health care for spouses, dependents, and family caregivers
  • Breadcrumb = Family health benefits <== this should be updated to use the h1 instead

Screenshot 2023-12-18 at 11 21 54 AM

Change management / Stakeholder team notes:

  • Requesting team = Sitewide CAIA (IA)
  • CAIA's OCTODE product owner = Mikki Northuis
  • Time constraints / launch deadlines: CAIA is implementing some IA updates that are blocked until this gets changed.
  • Other affected teams = Public Websites, Facilities (own FE templates)
    • This will need change management with contributing Drupal teams. These teams will need to confirm expected behavior for all their CMS-driven FE products after any breadcrumb configuration change in the CMS, tbd.

Acceptance Criteria

  • Stakeholder teams have signed off on the change
  • Page-level/last crumb Breadcrumbs on left-nav pages should match the page's H1
  • Page-level/last crumb Breadcrumbs on no left-nav pages should match the page's H1

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    BreadcrumbsCMS + FE componentCMS TeamCMS Product team that manages both editor exp and devopsDrupal engineeringCMS team practice areaNeeds refiningIssue status

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions