Sub navigation

Link to sibling pages in a multi-page section of your service.

Contents

Open this example in a new tab

<nav class="x-govuk-sub-navigation" aria-labelledby="sub-navigation-heading">
  <h2 class="govuk-visually-hidden" id="sub-navigation-heading">Pages in this section</h2>
  <ul class="x-govuk-sub-navigation__section">
    <li class="x-govuk-sub-navigation__section-item">
      <a class="x-govuk-sub-navigation__link" href="/about">About this project</a>
    </li>
    <li class="x-govuk-sub-navigation__section-item x-govuk-sub-navigation__section-item--current">
      <a class="x-govuk-sub-navigation__link" href="/contact" aria-current="true">Contact us</a>
      <ul class="x-govuk-sub-navigation__section x-govuk-sub-navigation__section--nested">
        <li class="x-govuk-sub-navigation__section-item">
          <a class="x-govuk-sub-navigation__link" href="/contact/email">By email</a>
        </li>
        <li class="x-govuk-sub-navigation__section-item">
          <a class="x-govuk-sub-navigation__link" href="/contact/telephone">By telephone</a>
        </li>
      </ul>
    </li>
  </ul>
</nav>

{{ xGovukSubNavigation({
  items: [{
    text: "About this project",
    href: "/about"
  }, {
    text: "Contact us",
    href: "/contact",
    current: true,
    parent: true,
    children: [{
      text: "By email",
      href: "/contact/email"
    }, {
      text: "By telephone",
      href: "/contact/telephone"
    }]
  }]
}) }}

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
items	Array	Required. An array of navigation links. See items.
visuallyHiddenTitle	string	A hidden title for the navigation. Defaults to ‘Pages in this section’.
classes	string	Classes to add to the sub navigation container.
attributes	object	HTML attributes (for example data attributes) to add to the container.

Options for items

Name	Type	Description
text	string	Required. Text of the navigation link.
href	string	Required. The value of the navigation link’s href attribute.
current	boolean	Indicate that the item is the current page.
parent	boolean	Indicate if the item is a parent. Use when the current item or any of its children are active.
theme	string	A name to group items by. If several navigation items share the same theme, they will appear together under that name.
children	Array	An array of items as child navigation links. See children.

Options for children

Name	Type	Description
text	string	Required. Text of the navigation link.
href	string	Required. The value of the navigation link’s href attribute.
current	boolean	Indicate that the item is the current page.