name: "Breadcrumbs"
description: "Navigational breadcrumbs, showing page hierarchy"
body: |
  Accepts an array of breadcrumb objects. Each crumb must have a title and a URL.
  Links have tracking data but links to the homepage (any link with a url of "/") will be tracked separately as `homeLinkClicked`
shared_accessibility_criteria:
  - link
accessibility_criteria:
  The breadcrumb links must have a text contrast ratio higher than 4.5:1 against the background colour to meet WCAG AA
  (this especially applies when [using the inverse flag](/component-guide/breadcrumbs/inverse)).
display_html: true
examples:
  default:
    data:
      breadcrumbs:
      - title: 'Section'
        url: '/section'
      - title: 'Sub-section'
        url: '/section/sub-section'
  inverse:
    description: On a dark background, such as the header of topic pages
    data:
      breadcrumbs:
      - title: 'Section'
        url: '/section'
      - title: 'Sub-section'
        url: '/section/sub-section'
        title: 'Education of disadvantaged children'
        is_current_page: true
      inverse: true
    context:
      dark_background: true
  no_breadcrumbs:
    data:
      breadcrumbs: []
  single_section:
    data:
      breadcrumbs:
      - title: 'Section'
        url: '/section'
  many_breadcrumbs:
    data:
      breadcrumbs:
      - title: 'Home'
        url: '/'
      - title: 'Section'
        url: '/section'
      - title: 'Sub-section'
        url: '/section/sub-section'
      - title: 'Sub Sub-section'
        url: '/section/sub-section/sub-sub-section'
  no_home:
    data:
      breadcrumbs:
      - title: 'Service Manual'
        url: '/service-manual'
      - title: 'Agile Delivery'
        url: '/service-manual/agile-delivery'
  real:
    data:
      breadcrumbs:
      - title: 'Home'
        url: '/'
      - title: 'Passports, travel and living abroad'
        url: '/browse/abroad'
      - title: 'Travel abroad'
        url: '/browse/abroad/travel-abroad'
  last_breadcrumb_is_current_page:
    data:
      breadcrumbs:
      - title: 'Home'
        url: '/'
      - title: 'Passports, travel and living abroad'
        url: '/browse/abroad'
      - title: 'Travel abroad'
  highlight_current_page:
    description: This is currently used on pages tagged to the taxonomy, such as [on this page](https://www.gov.uk/guidance/pupil-premium-information-for-schools-and-alternative-provision-settings).
    data:
      breadcrumbs:
      - title: 'Home'
        url: '/'
      - title: 'Education, training and skills'
        url: '/education'
      - title: 'Education of disadvantaged children'
        is_current_page: true
  collapse_on_mobile:
    description: This is currently used within on pages tagged to the taxonomy, such as [on this page](https://www.gov.uk/guidance/pupil-premium-information-for-schools-and-alternative-provision-settings).
    data:
      collapse_on_mobile: true
      breadcrumbs:
      - title: 'Home'
        url: '/'
      - title: 'Education, training and skills'
        url: '/education'
        is_page_parent: true
      - title: 'Education of disadvantaged children'