Password input 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 Password input 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.

Primary options
Name Type Description
id string The ID of the input. Defaults to the value of name.
name string Required. The name of the input, which is submitted with the form data.
value string Optional initial value of the input.
disabled boolean If true, input will be disabled.
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 text input component. See macro options for label.
hint object Can be used to add a hint to a text input component. See macro options for hint.
errorMessage object Can be used to add an error message to the text input 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 text input component. See macro options for formGroup.
classes string Classes to add to the input.
autocomplete string Attribute to meet WCAG success criterion 1.3.5: Identify input purpose. See the Autofill section in the HTML standard for full list of attributes that can be used. Default is "current-password".
attributes object HTML attributes (for example data attributes) to add to the input.
showPasswordText string Button text when the password is hidden. Defaults to "Show".
hidePasswordText string Button text when the password is visible. Defaults to "Hide".
showPasswordAriaLabelText string Button text exposed to assistive technologies, like screen readers, when the password is hidden. Defaults to "Show password".
hidePasswordAriaLabelText string Button text exposed to assistive technologies, like screen readers, when the password is visible. Defaults to "Hide password".
passwordShownAnnouncementText string Announcement made to screen reader users when their password has become visible in plain text. Defaults to "Your password is visible".
passwordHiddenAnnouncementText string Announcement made to screen reader users when their password has been obscured and is not visible. Defaults to "Your password is hidden".
button object Optional object allowing customisation of the toggle button. See macro options for button.
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 input used by the text input component. See macro options for formGroup beforeInput.
afterInput object Content to add after the input used by the text input component. See macro options for formGroup afterInput.
Options for formGroup beforeInput object
Name Type Description
text string Required. Text to add before the input. If html is provided, the text option will be ignored.
html string Required. HTML to add before the input. 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 input. If html is provided, the text option will be ignored.
html string Required. HTML to add after the input. If html is provided, the text option will be ignored.
Options for button object
Name Type Description
classes string Classes to add to the button.
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.