Sha256: ce4104207e856770132b0663d2694afd6f7d092c51a6792ceca5647478a40e4a

Contents?: true

Size: 1.95 KB

Versions: 42

Compression:

Stored size: 1.95 KB

Contents

name: Contextual breadcrumbs
description: Breadcrumbs that shows different things depending on the page
body: |
  This is a complex component that calls other components. For more accurate
  preview with real data, see the [contextual navigation preview][preview].

  There are 3 main variants of the component:

  - Step by step, which uses the [step by step header][header]
  - Parent breadcrumb, which uses the `parent` link of the page with the [breadcrumbs component][breadcrumbs]
  - Taxon breadcrumb, which uses the `taxons` link of the page with the [breadcrumbs component][breadcrumbs]

  It must always used [together with the contextual sidebar][sidebar] and [footer].

  [preview]: /contextual-navigation
  [header]: /component-guide/step_by_step_nav_header
  [footer]: /component-guide/contextual_footer
  [sidebar]: /component-guide/contextual_sidebar
  [breadcrumbs]: https://components.publishing.service.gov.uk/component-guide/breadcrumbs
accessibility_criteria: |
  Components called by this component must be accessible
examples:
  default:
    data:
      content_item:
        title: "A content item"
  inverse:
    description: Passes the `inverse` option to the breadcrumbs, if shown.
    data:
      content_item:
        title: "Another content item"
      inverse: true
    context:
      dark_background: true
  with_ga4_tracking:
    description: |
      Adds GA4 tracking to the step by step nav header component when it is rendered as a breadcrumb. See the 
      [ga4-link-tracker documentation](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics-ga4/ga4-link-tracker.md) for more information.
      Note: tracking on regular breadcrumbs is enabled by default and does not require activating.
    data:
      ga4_tracking: true
      content_item:
        title: "A content item"
        links:
          part_of_step_navs:
            - title: "Learn to drive a car: step by step"
              base_path: "/micropigs-vs-micropugs"

Version data entries

42 entries across 42 versions & 1 rubygems

Version Path
govuk_publishing_components-35.21.4 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.21.3 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.21.2 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.21.1 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.21.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.20.1 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.20.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.19.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.18.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.17.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.16.1 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.16.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.15.5 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.15.4 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.15.3 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.15.2 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.15.1 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.15.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.14.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-35.13.2 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml