Components

Skip link

Use the skip link component to help keyboard-only users skip to the main content on a page.

Open this skip link example in a new tab

To view the skip link component tab to this example, or click inside this example and press tab.

Skip to main content
HTML 
<div>
  <p class="govuk-body" id="content">
    To view the skip link component tab to this example, or click inside this
    example and press tab.
  </p>
  <a href="#content" class="govuk-skip-link" data-module="govuk-skip-link"
    >Skip to main content</a
  >
</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
text string Required.

If html is set, this is not required. Text to use within the skip link component. 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 skip link component. If html is provided, the text option will be ignored.
href string

The value of the skip link’s href attribute. Defaults to "#content" if you do not provide a value.
classes string

Classes to add to the skip link.
attributes object

HTML attributes (for example data attributes) to add to the skip link.

 
{%- from "moduk/components/skip-link/macro.njk" import modukSkipLink -%}

{# Wrapped in a <div> so there is one root element, for visual regression tests to use -#}

<div>
  <p class="govuk-body" id="content">To view the skip link component tab to this example, or click inside this example and press tab.</p>
  {{ modukSkipLink({
    text: "Skip to main content",
    href: "#content"
  }) -}}
</div>

See GOV.UK skip link component guidance for:

  • when to use this component
  • 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.