Blue background
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 |
|---|---|---|
| primaryReference | object | Required. The primary reference, see primaryReference |
| secondaryReference | object | The secondary reference, see secondaryReference |
| status | object | The claim status, see status |
| classes | string | Additional classes to add to the quick reference component |
| ariaLabel | string | value for the aria label, this defaults to Quick reference |
| attributes | object | HTML Attributes (data attributes) to the quick reference component |
Options for primaryReference object
| Name | Type | Description |
|---|---|---|
| text | string | Required. Text to use within the primary reference |
| value | string | Required. Value to use within the primary reference |
Options for secondaryReference object
| Name | Type | Description |
|---|---|---|
| text | string | Required. Text to use within the secondary reference |
| textDisplay | boolean | Required. Allow description to be displayed |
| value | string | Required. Value to use within the secondary reference |
Options for status object
| Name | Type | Description |
|---|---|---|
| text | string | Required. Text to use within claim status |
| textDisplay | boolean | Allow status description to be displayed |
| value | string | Required. Value to use within claim status |
| classes | string | Additional classes to add to claim status |