Select 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 Select 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
id	string	ID for the select box. Defaults to the value of name.
name	string	Required. Name property for the select.
items	array	Required. The items within the select component. See macro options for items.
value	string	Value for the option which should be selected. Use this as an alternative to setting the selected option on each individual item.
disabled	boolean	If true, select box will be disabled. Use the disabled option on each individual item to only disable certain options.
describedBy	string	One or more element IDs to add to the aria-describedby attribute, used to provide additional descriptive information for screenreader users.
label	object	Required. The label used by the select component. See macro options for label.
hint	object	Can be used to add a hint to the select component. See macro options for hint.
errorMessage	object	Can be used to add an error message to the select component. The error message component will not display if you use a falsy value for errorMessage, for example false or null. See macro options for errorMessage.
formGroup	object	Additional options for the form group containing the select component. See macro options for formGroup.
classes	string	Classes to add to the select.
attributes	object	HTML attributes (for example data attributes) to add to the select.

Options for items array objects

Name	Type	Description
value	string	Value for the option. If this is omitted, the value is taken from the text content of the option element.
text	string	Required. Text for the option item.
selected	boolean	Whether the option should be selected when the page loads. Takes precedence over the top-level value option.
disabled	boolean	Sets the option item as disabled.
attributes	object	HTML attributes (for example data attributes) to add to the option.

Options for formGroup object

Name	Type	Description
classes	string	Classes to add to the form group (for example to show error state for the whole group).
attributes	object	HTML attributes (for example data attributes) to add to the form group.
beforeInput	object	Content to add before the select used by the select component. See macro options for formGroup beforeInput.
afterInput	object	Content to add after the select used by the select component. See macro options for formGroup afterInput.

Options for formGroup beforeInput object

Name	Type	Description
text	string	Required. Text to add before the select. If html is provided, the text option will be ignored.
html	string	Required. HTML to add before the select. If html is provided, the text option will be ignored.

Options for formGroup afterInput object

Name	Type	Description
text	string	Required. Text to add after the select. If html is provided, the text option will be ignored.
html	string	Required. HTML to add after the select. If html is provided, the text option will be ignored.

Options for label component

Name	Type	Description
text	string	Required. If html is set, this is not required. Text to use within the label. 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 label. If html is provided, the text option will be ignored.
for	string	The value of the for attribute, the ID of the input the label is associated with.
isPageHeading	boolean	Whether the label also acts as the heading for the page.
classes	string	Classes to add to the label tag.
attributes	object	HTML attributes (for example data attributes) to add to the label tag.

Options for hint component

Name	Type	Description
text	string	Required. If html is set, this is not required. Text to use within the hint. 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 hint. If html is provided, the text option will be ignored.
id	string	Optional ID attribute to add to the hint span tag.
classes	string	Classes to add to the hint span tag.
attributes	object	HTML attributes (for example data attributes) to add to the hint span tag.