Use up and down keys to navigate results once you've typed more than two characters. Use the enter key to select a result. Touch device users, explore by touch or with swipe gestures.
Details
Use the details component to make a page easier to read by condensing information that is only needed by some users.
{% from "components/details/_macro.njk" import onsDetails %}
{{
onsDetails({
"id": "details",
"title": "What is a photovoltaic system?",
"content": "<p>A typical photovoltaic system employs solar panels, each comprising a number of solar cells, which generate electrical power. PV installations may be ground-mounted, rooftop mounted or wall mounted. The mount may be fixed, or use a solar tracker to follow the sun across the sky.</p>"
})
}}
Nunjucks macro options
Name
Type
Required
Description
id
string
true
HTML id attribute for the details
classes
string
false
Classes to add to the details outer element
title
string
true
The title text for the details heading
titleTag
string
false
The HTML heading tag to wrap the title text in for it’s correct semantic order on the page. Will default to an h2
content
string
true
HTML content for the details
saveState
boolean
false
Saves the opened state of the details to local storage so it remains open when the page reloads
open
boolean
false
Forces the details to be open when the page loads
attributes
object
false
HTML attributes (for example, data attributes) to add to the details
headingAttributes
object
false
HTML attributes (for example, data attributes) to add to the details header element
contentAttributes
object
false
HTML attributes (for example, data attributes) to add to the details content element
HTML
<details id="details" class="ons-details ons-js-details">
<summary class="ons-details__heading ons-js-details-heading">
<h2 class="ons-details__title">What is a photovoltaic system?</h2>
<span class="ons-details__icon">
<svg class="ons-svg-icon" viewBox="0 0 8 13" xmlns="http://www.w3.org/2000/svg" focusable="false"
fill="currentColor">
<path
d="M5.74,14.28l-.57-.56a.5.5,0,0,1,0-.71h0l5-5-5-5a.5.5,0,0,1,0-.71h0l.57-.56a.5.5,0,0,1,.71,0h0l5.93,5.93a.5.5,0,0,1,0,.7L6.45,14.28a.5.5,0,0,1-.71,0Z"
transform="translate(-5.02 -1.59)" />
</svg>
</span>
</summary>
<div id="details-content" class="ons-details__content ons-js-details-content">
<p>A typical photovoltaic system employs solar panels, each comprising a number of solar cells, which generate
electrical power. PV installations may be ground-mounted, rooftop mounted or wall mounted. The mount may be fixed,
or use a solar tracker to follow the sun across the sky.</p>
</div>
</details>
When to use this component
The details component can be used to condense a single block of content into a selectable heading, allowing the user to reveal it if they need it.
Good uses of the component are:
to reveal additional help at the point where a user may need it, for example, to help answer a question
to reveal information only needed by a first-time user
to show the definition of a term that may not be well understood
When not to use this component
Do not use the details component to hide information that most of your users will need to progress with their task.
If you need to use more than one details component together on a page, use an accordion.
If users need to be able to quickly switch between blocks of closely related content, use tabs.
How to use this component
The details component uses JavaScript so when it is turned off, the content is expanded and displayed as a standard heading and block of content.
Use an appropriate heading tag (h2, h3 etc) for the titleTag to provide the correct semantic hierarchy to the document with the rest of the page. The default is H2 if titleTag is not provided.
Use a clear label
The details component hides content so make sure your heading is clear so the user doesn’t need to work hard to understand if they need to expand it.
Google analytics
Optionally pass event tracking data attributes for Google Analytics using:
data-ga="click"
data-ga-category="definition"
data-ga-action="Open/Close panel"
data-ga-label="{TITLE}"
Variants
Details component with save state enabled
Use this when you need to include a link or call to action within a details component that does not open in a new window.
This will make sure that the component remains expanded if the user returns to the page using the back button in their browser.
{% from "components/details/_macro.njk" import onsDetails %}
{{
onsDetails({
"id": "details-with-save",
"title": "What is a photovoltaic system?",
"content": "<p>A typical photovoltaic system employs solar panels, each comprising a number of solar cells, which generate electrical power. PV installations may be ground-mounted, rooftop mounted or wall mounted. The mount may be fixed, or use a solar tracker to follow the sun across the sky.</p>",
"saveState": "true"
})
}}
Nunjucks macro options
Name
Type
Required
Description
id
string
true
HTML id attribute for the details
classes
string
false
Classes to add to the details outer element
title
string
true
The title text for the details heading
titleTag
string
false
The HTML heading tag to wrap the title text in for it’s correct semantic order on the page. Will default to an h2
content
string
true
HTML content for the details
saveState
boolean
false
Saves the opened state of the details to local storage so it remains open when the page reloads
open
boolean
false
Forces the details to be open when the page loads
attributes
object
false
HTML attributes (for example, data attributes) to add to the details
headingAttributes
object
false
HTML attributes (for example, data attributes) to add to the details header element
contentAttributes
object
false
HTML attributes (for example, data attributes) to add to the details content element
HTML
<details id="details-with-save" class="ons-details ons-js-details" data-save-state="true">
<summary class="ons-details__heading ons-js-details-heading">
<h2 class="ons-details__title">What is a photovoltaic system?</h2>
<span class="ons-details__icon">
<svg class="ons-svg-icon" viewBox="0 0 8 13" xmlns="http://www.w3.org/2000/svg" focusable="false"
fill="currentColor">
<path
d="M5.74,14.28l-.57-.56a.5.5,0,0,1,0-.71h0l5-5-5-5a.5.5,0,0,1,0-.71h0l.57-.56a.5.5,0,0,1,.71,0h0l5.93,5.93a.5.5,0,0,1,0,.7L6.45,14.28a.5.5,0,0,1-.71,0Z"
transform="translate(-5.02 -1.59)" />
</svg>
</span>
</summary>
<div id="details-with-save-content" class="ons-details__content ons-js-details-content">
<p>A typical photovoltaic system employs solar panels, each comprising a number of solar cells, which generate
electrical power. PV installations may be ground-mounted, rooftop mounted or wall mounted. The mount may be fixed,
or use a solar tracker to follow the sun across the sky.</p>
</div>
</details>
Nesting other components in a details component
You can use other components inside of the details component.
An example of this is the details component with a warning panel:
{% from "components/details/_macro.njk" import onsDetails %}
{% from "components/panel/_macro.njk" import onsPanel %}
{%
call onsDetails({
"id": "details",
"title": "Need to answer separately from your household?"
})
%}
<p>If you need to answer separately from the people you live with, you can <a href="#0">request an individual access code</a> to start a separate survey.</p>
{% call onsPanel({
type: "warn"
})
%}
Someone in your household must still complete a survey using a household access code
{% endcall %}
{% endcall %}
Nunjucks macro options
Name
Type
Required
Description
id
string
true
HTML id attribute for the details
classes
string
false
Classes to add to the details outer element
title
string
true
The title text for the details heading
titleTag
string
false
The HTML heading tag to wrap the title text in for it’s correct semantic order on the page. Will default to an h2
content
string
true
HTML content for the details
saveState
boolean
false
Saves the opened state of the details to local storage so it remains open when the page reloads
open
boolean
false
Forces the details to be open when the page loads
attributes
object
false
HTML attributes (for example, data attributes) to add to the details
headingAttributes
object
false
HTML attributes (for example, data attributes) to add to the details header element
contentAttributes
object
false
HTML attributes (for example, data attributes) to add to the details content element
HTML
<details id="details" class="ons-details ons-js-details">
<summary class="ons-details__heading ons-js-details-heading">
<h2 class="ons-details__title">Need to answer separately from your household?</h2>
<span class="ons-details__icon">
<svg class="ons-svg-icon" viewBox="0 0 8 13" xmlns="http://www.w3.org/2000/svg" focusable="false"
fill="currentColor">
<path
d="M5.74,14.28l-.57-.56a.5.5,0,0,1,0-.71h0l5-5-5-5a.5.5,0,0,1,0-.71h0l.57-.56a.5.5,0,0,1,.71,0h0l5.93,5.93a.5.5,0,0,1,0,.7L6.45,14.28a.5.5,0,0,1-.71,0Z"
transform="translate(-5.02 -1.59)" />
</svg>
</span>
</summary>
<div id="details-content" class="ons-details__content ons-js-details-content">
<p>If you need to answer separately from the people you live with, you can <a href="#0">request an individual access
code</a> to start a separate survey.</p>
<div class="ons-panel ons-panel--warn ons-panel--no-title">
<span class="ons-panel__icon" aria-hidden="true">!</span>
<span class="ons-panel__assistive-text ons-u-vh">Warning: </span>
<div class="ons-panel__body"> Someone in your household must still complete a survey using a household access code
</div>
</div>
</div>
</details>
!Warning:
Do not use this for content that is important to every user
Only use a warning panel inside of a details component to warn users about something that it is only relevant to those that have opened the details component.