Breadcrumbs 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 Breadcrumbs 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.
| Name | Type | Description |
|---|---|---|
| items | array | Required. The items within breadcrumbs. See macro options for items. |
| classes | string | Classes to add to the breadcrumbs container. |
| collapse |
boolean | When true, the breadcrumbs will collapse to the first and last item only on tablet breakpoint and below. |
| attributes | object | HTML attributes (for example data attributes) to add to the breadcrumbs container. |
| label |
string | Plain text label identifying the landmark to screen readers. Defaults to “Breadcrumb”. |
| Name | Type | Description |
|---|---|---|
| text | string |
Required.
If html is set, this is not required. Text to use within the breadcrumbs item. 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 breadcrumbs item. If html is provided, the text option will be ignored.
|
| href | string | Link for the breadcrumbs item. If not specified, breadcrumbs item is a normal list item. |
| attributes | object | HTML attributes (for example data attributes) to add to the individual crumb. |