Tabs 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 Tabs 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	This is used for the main component and to compose the ID attribute for each item.
idPrefix	string	Optional prefix. This is used to prefix the id attribute for each tab item and panel, separated by -.
title	string	Title for the tabs table of contents.
items	array	Required. The individual tabs within the tabs component. See macro options for items.
classes	string	Classes to add to the tabs component.
attributes	object	HTML attributes (for example data attributes) to add to the tabs component.

Options for items array objects

Name	Type	Description
id	string	Required. Specific ID attribute for the tab item. If omitted, then idPrefix string is required instead.
label	string	Required. The text label of a tab item.
attributes	object	HTML attributes (for example data attributes) to add to the tab.
panel	object	Required. The contents of each tab within the tabs component. This is referenced as a panel. See macro options for items panel.

Options for items panel object

Name	Type	Description
text	string	Required. If html is set, this is not required. Text to use within each tab panel. 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 each tab panel. If html is provided, the text option will be ignored.
attributes	object	HTML attributes (for example data attributes) to add to the tab panel.