Generic header 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 Generic header 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
url string The URL of the logo link. Defaults to the root of the current web domain (“/”).
logoText string Required. If logoHtml is set, this is not required. Text content for the logo section of the Generic header.
logoHtml string Required. If logoText is set, this is not required. HTML content for the logo section of the Generic header.
containerClasses string Classes for the container. Useful if you want to make the Generic header fixed width.
classes string Classes to add to the Generic header container.
attributes object HTML attributes (for example, data attributes) to add to the Generic header container.