Components

Details

Make a page easier to scan by letting users reveal more detailed information only if they need it.

Help with nationality
We need to know your nationality so we can work out which elections you’re entitled to vote in. If you cannot provide your nationality, you’ll have to send copies of identity documents through the post.
<details class="govuk-details">
  <summary class="govuk-details__summary">
    Help with nationality
  </summary>
  <div class="govuk-details__text">
    We need to know your nationality so we can work
    out which elections you’re entitled to vote in. If
    you cannot provide your nationality, you’ll have
    to send copies of identity documents through the
    post.
  </div>
</details>
<Details summary="Help with nationality">
  We need to know your nationality so we can work out
  which elections you’re entitled to vote in. If you
  cannot provide your nationality, you’ll have to send
  copies of identity documents through the post.
</Details>
Props
Name Type Default Description
id string - 'id' attribute to place on the base HTML element
classBlock string - Block name override in BEM style classes applied to all elements
classModifiers other - BEM style modifiers to apply to the base HTML element
className string - Extra classes to apply to the base HTML element
accept string -
acceptCharset string -
action string -
allowFullScreen boolean -
allowTransparency boolean -
alt string -
as string -
async boolean -
autoComplete string -
autoFocus boolean -
autoPlay boolean -
capture other -
cellPadding other -
cellSpacing other -
charSet string -
challenge string -
checked boolean -
cite string -
classID string -
cols number -
colSpan number -
content string -
controls boolean -
coords string -
crossOrigin string -
data string -
dateTime string -
default boolean -
defer boolean -
disabled boolean -
download other -
encType string -
form string -
formAction string -
formEncType string -
formMethod string -
formNoValidate boolean -
formTarget string -
frameBorder other -
headers string -
height other -
high number -
href string -
hrefLang string -
htmlFor string -
httpEquiv string -
integrity string -
keyParams string -
keyType string -
kind string -
label string -
list string -
loop boolean -
low number -
manifest string -
marginHeight number -
marginWidth number -
max other -
maxLength number -
media string -
mediaGroup string -
method string -
min other -
minLength number -
multiple boolean -
muted boolean -
name string -
nonce string -
noValidate boolean -
open boolean -
optimum number -
pattern string -
placeholder string -
playsInline boolean -
poster string -
preload string -
readOnly boolean -
rel string -
required boolean -
reversed boolean -
rows number -
rowSpan number -
sandbox string -
scope string -
scoped boolean -
scrolling string -
seamless boolean -
selected boolean -
shape string -
size number -
sizes string -
span number -
src string -
srcDoc string -
srcLang string -
srcSet string -
start number -
step other -
summary string - The summary of the content
target string -
type string -
useMap string -
value other -
width other -
wmode string -
wrap string -
defaultChecked boolean -
defaultValue other -
suppressContentEditableWarning boolean -
suppressHydrationWarning boolean -
accessKey string -
contentEditable other -
contextMenu string -
dir string -
draggable other -
hidden boolean -
lang string -
slot string -
spellCheck other -
style other -
tabIndex number -
title string -
translate enum -
radioGroup string -
role string -
about string -
datatype string -
inlist other -
prefix string -
property string -
resource string -
typeof string -
vocab string -
autoCapitalize string -
autoCorrect string -
autoSave string -
color string -
itemProp string -
itemScope boolean -
itemType string -
itemID string -
itemRef string -
results number -
security string -
unselectable enum -
inputMode enum - Hints at the type of data that might be entered by the user while editing the element or its contents
is string - Specify that a standard HTML element should behave like a defined custom built-in element
aria-activedescendant string - Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomic other - Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete enum - Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
aria-busy other - Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
aria-checked other - Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcount number - Defines the total number of columns in a table, grid, or treegrid.
aria-colindex number - Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colspan number - Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controls string - Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-current other - Indicates the element that represents the current item within a container or set of related elements.
aria-describedby string - Identifies the element (or elements) that describes the object.
aria-details string - Identifies the element that provides a detailed, extended description for the object.
aria-disabled other - Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect enum - Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessage string - Identifies the element that provides an error message for the object.
aria-expanded other - Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowto string - Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
aria-grabbed other - Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopup other - Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hidden other - Indicates whether the element is exposed to an accessibility API.
aria-invalid other - Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcuts string - Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-label string - Defines a string value that labels the current element.
aria-labelledby string - Identifies the element (or elements) that labels the current element.
aria-level number - Defines the hierarchical level of an element within a structure.
aria-live enum - Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modal other - Indicates whether an element is modal when displayed.
aria-multiline other - Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectable other - Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation enum - Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-owns string - Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
aria-placeholder string - Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinset number - Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressed other - Indicates the current "pressed" state of toggle buttons.
aria-readonly other - Indicates that the element is not editable, but is otherwise operable.
aria-relevant enum - Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-required other - Indicates that user input is required on the element before a form may be submitted.
aria-roledescription string - Defines a human-readable, author-localized description for the role of an element.
aria-rowcount number - Defines the total number of rows in a table, grid, or treegrid.
aria-rowindex number - Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowspan number - Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selected other - Indicates the current "selected" state of various widgets.
aria-setsize number - Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort enum - Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemax number - Defines the maximum allowed value for a range widget.
aria-valuemin number - Defines the minimum allowed value for a range widget.
aria-valuenow number - Defines the current value for a range widget.
aria-valuetext string - Defines the human readable text alternative of aria-valuenow for a range widget.
dangerouslySetInnerHTML other -
onCopy function -
onCopyCapture function -
onCut function -
onCutCapture function -
onPaste function -
onPasteCapture function -
onCompositionEnd function -
onCompositionEndCapture function -
onCompositionStart function -
onCompositionStartCapture function -
onCompositionUpdate function -
onCompositionUpdateCapture function -
onFocus function -
onFocusCapture function -
onBlur function -
onBlurCapture function -
onChange function -
onChangeCapture function -
onBeforeInput function -
onBeforeInputCapture function -
onInput function -
onInputCapture function -
onReset function -
onResetCapture function -
onSubmit function -
onSubmitCapture function -
onInvalid function -
onInvalidCapture function -
onLoad function -
onLoadCapture function -
onError function -
onErrorCapture function -
onKeyDown function -
onKeyDownCapture function -
onKeyPress function -
onKeyPressCapture function -
onKeyUp function -
onKeyUpCapture function -
onAbort function -
onAbortCapture function -
onCanPlay function -
onCanPlayCapture function -
onCanPlayThrough function -
onCanPlayThroughCapture function -
onDurationChange function -
onDurationChangeCapture function -
onEmptied function -
onEmptiedCapture function -
onEncrypted function -
onEncryptedCapture function -
onEnded function -
onEndedCapture function -
onLoadedData function -
onLoadedDataCapture function -
onLoadedMetadata function -
onLoadedMetadataCapture function -
onLoadStart function -
onLoadStartCapture function -
onPause function -
onPauseCapture function -
onPlay function -
onPlayCapture function -
onPlaying function -
onPlayingCapture function -
onProgress function -
onProgressCapture function -
onRateChange function -
onRateChangeCapture function -
onSeeked function -
onSeekedCapture function -
onSeeking function -
onSeekingCapture function -
onStalled function -
onStalledCapture function -
onSuspend function -
onSuspendCapture function -
onTimeUpdate function -
onTimeUpdateCapture function -
onVolumeChange function -
onVolumeChangeCapture function -
onWaiting function -
onWaitingCapture function -
onAuxClick function -
onAuxClickCapture function -
onClick function -
onClickCapture function -
onContextMenu function -
onContextMenuCapture function -
onDoubleClick function -
onDoubleClickCapture function -
onDrag function -
onDragCapture function -
onDragEnd function -
onDragEndCapture function -
onDragEnter function -
onDragEnterCapture function -
onDragExit function -
onDragExitCapture function -
onDragLeave function -
onDragLeaveCapture function -
onDragOver function -
onDragOverCapture function -
onDragStart function -
onDragStartCapture function -
onDrop function -
onDropCapture function -
onMouseDown function -
onMouseDownCapture function -
onMouseEnter function -
onMouseLeave function -
onMouseMove function -
onMouseMoveCapture function -
onMouseOut function -
onMouseOutCapture function -
onMouseOver function -
onMouseOverCapture function -
onMouseUp function -
onMouseUpCapture function -
onSelect function -
onSelectCapture function -
onTouchCancel function -
onTouchCancelCapture function -
onTouchEnd function -
onTouchEndCapture function -
onTouchMove function -
onTouchMoveCapture function -
onTouchStart function -
onTouchStartCapture function -
onPointerDown function -
onPointerDownCapture function -
onPointerMove function -
onPointerMoveCapture function -
onPointerUp function -
onPointerUpCapture function -
onPointerCancel function -
onPointerCancelCapture function -
onPointerEnter function -
onPointerEnterCapture function -
onPointerLeave function -
onPointerLeaveCapture function -
onPointerOver function -
onPointerOverCapture function -
onPointerOut function -
onPointerOutCapture function -
onGotPointerCapture function -
onGotPointerCaptureCapture function -
onLostPointerCapture function -
onLostPointerCaptureCapture function -
onScroll function -
onScrollCapture function -
onWheel function -
onWheelCapture function -
onAnimationStart function -
onAnimationStartCapture function -
onAnimationEnd function -
onAnimationEndCapture function -
onAnimationIteration function -
onAnimationIterationCapture function -
onTransitionEnd function -
onTransitionEndCapture function -
ref other -
key other -

When to use this component

Use the details component to make a page easier to scan when it contains information that only some users will need.

When not to use this component

Do not use the details component to hide information that the majority of your users will need.

Details, accordions and tabs

Details, accordions, and tabs all hide sections of content which a user can choose to reveal.

Use the details component instead of tabs or an accordion if you only have 1 section of content.

The details component is less visually prominent than tabs and accordions, so tends to work better for content which is not as important to users.

How it works

The details component is a short link that expands into more detailed help text when a user clicks on it.

Help with nationality
We need to know your nationality so we can work out which elections you’re entitled to vote in. If you cannot provide your nationality, you’ll have to send copies of identity documents through the post.
<details class="govuk-details">
  <summary class="govuk-details__summary">
    Help with nationality
  </summary>
  <div class="govuk-details__text">
    We need to know your nationality so we can work
    out which elections you’re entitled to vote in. If
    you cannot provide your nationality, you’ll have
    to send copies of identity documents through the
    post.
  </div>
</details>
<Details summary="Help with nationality">
  We need to know your nationality so we can work out
  which elections you’re entitled to vote in. If you
  cannot provide your nationality, you’ll have to send
  copies of identity documents through the post.
</Details>

Write clear link text

Make the link text short and descriptive so users can quickly work out if they need to click on it.