Sha256: b2b0e3e0717666f2a11a1674e5d53478fefe10df305d472d8b29f7ea3c654212

Contents?: true

Size: 1.91 KB

Versions: 85

Compression:

Stored size: 1.91 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
  without_ga4_tracking:
    description: |
      Disables GA4 tracking. Tracking is enabled by default. This includes GA4 tracking on 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.
    data:
      disable_ga4: 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

85 entries across 85 versions & 1 rubygems

Version Path
govuk_publishing_components-45.6.1 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-45.6.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-45.5.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-45.4.1 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-45.4.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-45.3.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-45.2.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-45.1.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-45.0.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.11.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.10.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.9.1 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.9.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.8.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.7.1 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.7.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.6.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.5.0 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.4.2 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
govuk_publishing_components-44.4.1 app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml