Files
notifications-admin/app/templates/components/uk_components/fieldset/macro-options.json
2022-12-14 11:55:21 -05:00

58 lines
2.4 KiB
JSON

[
{
"name": "describedBy",
"type": "string",
"required": false,
"description": "One or more element IDs to add to the `aria-describedby` attribute, used to provide additional descriptive information for screenreader users."
},
{
"name": "legend",
"type": "object",
"required": false,
"description": "Options for the legend",
"params": [
{
"name": "text",
"type": "string",
"required": true,
"description": "If `html` is set, this is not required. Text to use within the legend. If `html` is provided, the `text` argument will be ignored."
},
{
"name": "html",
"type": "string",
"required": true,
"description": "If `text` is set, this is not required. HTML to use within the legend. If `html` is provided, the `text` argument will be ignored."
},
{
"name": "classes",
"type": "string",
"required": false,
"description": "Classes to add to the legend."
},
{
"name": "isPageHeading",
"type": "boolean",
"required": false,
"description": "Whether the legend also acts as the heading for the page."
}
]
},
{
"name": "classes",
"type": "string",
"required": false,
"description": "Classes to add to the fieldset container."
},
{
"name": "attributes",
"type": "object",
"required": false,
"description": "HTML attributes (for example data attributes) to add to the fieldset container."
},
{
"name": "caller",
"type": "nunjucks-block",
"required": false,
"description": "Not strictly a parameter but [Nunjucks code convention](https://mozilla.github.io/nunjucks/templating.html#call). 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 fielset component in a `call` block. See [checkboxes component](https://github.com/alphagov/govuk-frontend/blob/master/src/components/checkboxes/template.njk#L86) for an example."
}
]