Work in progress
This page is a design preview. It may not contain the latest guidance and may not behave as expected.
Current guidance can always be found at design-system.dwp.gov.uk.
Use options to customise the appearance, content and behaviour of a component when using a macro, for example, changing the text.
Some options are required for the macro to work; these are marked as "Required" in the option description.
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 |
---|---|---|
serviceName | string | Required. The service name, this replaces the name value |
serviceUrl | string | Required. The service url |
action | string | the action of a link |
actionUrl | string | The action url |
profileName | string | The name of the person signed-in. |
classes | string | Additional classes to add to the claimant header |
attributes | object | HTML Attributes (data attributes) to add to the claimant header |