Fieldset 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 Fieldset 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 |
|---|---|---|
| described |
string |
One or more element IDs to add to the aria-describedby attribute, used to provide additional descriptive information for screenreader users.
|
| legend | object | The legend for the fieldset component. See macro options for legend. |
| classes | string | Classes to add to the fieldset container. |
| role | string | Optional ARIA role attribute. |
| attributes | object | HTML attributes (for example data attributes) to add to the fieldset container. |
| html | string | HTML to use/render within the fieldset element. |
| caller | nunjucks-block |
Not strictly a parameter but Nunjucks code convention. Using a call block enables you to call a macro with all the text inside the tag. This is helpful if you want to pass a lot of content into a macro. To use it, you will need to wrap the entire fieldset component in a call block.
|
| Name | Type | Description |
|---|---|---|
| text | string |
Required.
If html is set, this is not required. Text to use within the legend. 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 legend. If html is provided, the text option will be ignored.
|
| classes | string | Classes to add to the legend. |
| is |
boolean | Whether the legend also acts as the heading for the page. |