Components

Breadcrumbs

The breadcrumbs component helps users to understand where they are within a website’s structure and move between levels.

Open this breadcrumbs example in a new tab
  1. Home
  2. Components
  3. Breadcrumbs
HTML 
<div class="govuk-breadcrumbs">
  <ol class="govuk-breadcrumbs__list">
    <li class="govuk-breadcrumbs__list-item">
      <a class="govuk-breadcrumbs__link" href="#">Home</a>
    </li>
    <li class="govuk-breadcrumbs__list-item">
      <a class="govuk-breadcrumbs__link" href="#">Components</a>
    </li>
    <li class="govuk-breadcrumbs__list-item">
      <a class="govuk-breadcrumbs__link" href="#">Breadcrumbs</a>
    </li>
  </ol>
</div>
Nunjucks
Nunjucks macro options

Use options to customise the appearance, content and behaviour of a component when using a macro, for example, changing the text.

Some options are required for the macro to work; these are marked as "Required" in the option description.

If you’re using Nunjucks macros in production with "html" options, or ones ending with "html", you must sanitise the HTML to protect against cross-site scripting exploits.

Primary options
Name Type Description
items array Required.

The items within breadcrumbs.

See items.
classes string

Classes to add to the breadcrumbs container.
collapseOnMobile boolean

When true, the breadcrumbs will collapse to the first and last item only on tablet breakpoint and below.
attributes object

HTML attributes (for example data attributes) to add to the breadcrumbs container.
Options for items
Name Type Description
text string Required.

If html is set, this is not required. Text to use within the breadcrumbs item. If html is provided, the text option will be ignored.
html string Required.

If text is set, this is not required. HTML to use within the breadcrumbs item. If html is provided, the text option will be ignored.
href string

Link for the breadcrumbs item. If not specified, breadcrumbs item is a normal list item.
attributes object

HTML attributes (for example data attributes) to add to the individual crumb.

 
{% from "moduk/components/breadcrumbs/macro.njk" import modukBreadcrumbs -%}

{{ modukBreadcrumbs({
  items: [
    {
      text: "Home",
      href: "#"
    },
    {
      text: "Components",
      href: "#"
    },
    {
      text: "Breadcrumbs",
      href: "#"
    }
  ]
}) -}}

See GOV.UK breadcrumbs component guidance for:

  • when to use this component
  • when not to use it
  • how it works

Changes from the GOV.UK version

MOD.UK Design System components are closely based on GOV.UK Design System components.

For this component we’ve changed the font.

Have you tested this component?

Let us know how we could improve this component or share your user research findings.

Email the MOD.UK Design System team at design-system@digital.mod.uk

Need help?

Email the MOD.UK Design System team at design-system@digital.mod.uk if you have questions or feedback.