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 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 |
|---|---|---|
| text | string |
Required.
If html is set, this is not required. Text to use within the error message. 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 error message. If html is provided, the text option will be ignored.
|
| id | string |
ID attribute to add to the error message <p> tag.
|
| classes | string |
Classes to add to the error message <p> tag.
|
| attributes | object |
HTML attributes (for example data attributes) to add to the error message <p> tag.
|
| visually |
string |
A visually hidden prefix used before the error message. Defaults to "Error".
|