With links
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 |
|---|---|---|
| meta | object | Object containing options for the meta navigation., see meta |
| navigation | array | Array of items for use in the navigation section of the footer., see navigation |
| containerClasses | string | Classes that can be added to the inner container, useful if you want to make the footer full width. |
| classes | string | Classes to add to the footer component container. |
| attributes | object | HTML attributes (for example data attributes) to add to the footer component container. |
Options for meta object
| Name | Type | Description |
|---|---|---|
| visuallyHiddenTitle | string | Title for a meta item section. |
| html | string | HTML to add to the meta section of the footer, which will appear below any links specified using meta.items. |
| text | string | Text to add to the meta section of the footer, which will appear below any links specified using meta.items. If meta.html is specified, this option is ignored. |
| items | array | Array of items for use in the meta section of the footer., see meta items |
Options for meta items array object
| Name | Type | Description |
|---|---|---|
| text | string | Required. List item text in the meta section of the footer. |
| href | string | Required. List item href attribute in the meta section of the footer. |
| attributes | object | HTML attributes (for example data attributes) to add to the anchor in the footer navigation section. |
Options for navigation array object
| Name | Type | Description |
|---|---|---|
| title | string | Required. Title for a section. |
| columns | integer | Amount of columns to display items in navigation section of the footer. |
| width | string | Width of each navigation section in the footer. Defaults to full width. You can pass any design system grid width here, for example, 'one-third'; 'two-thirds'; 'one-half'. |
| items | array | Array of items to display in the list in navigation section of the footer., see navigation items |
Options for navigation items array object
| Name | Type | Description |
|---|---|---|
| text | string | Required. List item text in the navigation section of the footer. |
| href | string | Required. List item href attribute in the navigation section of the footer. Both `text` and `href` attributes need to be present to create a link. |
| attributes | object | HTML attributes (for example data attributes) to add to the anchor in the footer navigation section. |