Related navigation

Show related content when prototyping guidance pages.

Contents

Open this example in a new tab

<div class="x-govuk-related-navigation">
  <nav class="x-govuk-related-navigation__nav-section" aria-labelledby="related-navigation-related-content">
    <h2 class="x-govuk-related-navigation__main-heading" id="related-navigation-related-content">Related content</h2>
    <ul class="x-govuk-related-navigation__link-list">
      <li class="x-govuk-related-navigation__link">
        <a class="govuk-link x-govuk-related-navigation__section-link x-govuk-related-navigation__section-link--other" href="/school-performance-tables">Find and compare schools in England</a>
      </li>
      <li class="x-govuk-related-navigation__link">
        <a class="govuk-link x-govuk-related-navigation__section-link x-govuk-related-navigation__section-link--other" href="/types-of-school">Types of school</a>
      </li>
    </ul>
    <nav class="x-govuk-related-navigation__nav-section" aria-labelledby="related-navigation-explore-the-topic">
      <h3 class="x-govuk-related-navigation__sub-heading" id="related-navigation-explore-the-topic">Explore the topic</h3>
      <ul class="x-govuk-related-navigation__link-list">
        <li class="x-govuk-related-navigation__link">
          <a class="govuk-link x-govuk-related-navigation__section-link" href="/browse/education/school-life">Schools and curriculum</a>
        </li>
      </ul>
    </nav>
  </nav>
</div>

{{ xGovukRelatedNavigation({
  sections: [{
    items: [{
      text: "Find and compare schools in England",
      href: "/school-performance-tables"
    }, {
      text: "Types of school",
      href: "/types-of-school"
    }],
    subsections: [{
      title: "Explore the topic",
      items: [{
        text: "Schools and curriculum",
        href: "/browse/education/school-life"
      }]
    }]
  }]
}) }}

This component, based on one from GOV.UK Publishing components, may be useful if you are prototyping guidance pages that could be published on GOV.UK, or if your service needs to show related navigation.

You can use HTML or, if you are using Nunjucks or the GOV.UK Prototype Kit, you can use the Nunjucks macro.

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.

Name	Type	Description
headingLevel	integer	Heading level, from 1 to 6 (default is 2)
sections	array	An array of sections within the related navigation. See options for sections.
classes	string	Classes to add to the related navigation container
attributes	object	HTML attributes (for example data attributes) to add to the container

Options for sections array objects

Name	Type	Description
title	string	The title text that displays above the list of navigation links (default is ‘Related content’)
id	string	ID attribute to add to the section container
items	array	Required. An array of navigation links within the section. See options for items.
subsections	array	An array of subsections within the section. See options for subsections.

Options for subsections array objects

Name	Type	Description
title	string	The title text that displays above the list of navigation links
id	string	ID attribute to add to the subsection container
items	array	Required. An array of navigation links within the subsection. See options for items.

Options for items array objects

Name	Type	Description
text	string	Required. Text of the navigation link.
href	string	Required. The value of the navigation link’s href attribute.