Skip link Nunjucks macro options

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

Also see the guidance on the Skip link component page, which shows these options in use within each example.

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

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.