Unofficial

Internal

Components

Summary list

Use a summary list to summarise information, for example, a user’s responses at the end of a form.

Name

Sarah Philips

Change

Date of birth

5 January 1978

Change

Address

72 Guild Street
London
SE23 6FH

Change

Contact details

07700 900457

sarah.phillips@example.com

Change

HTML
React

<dl class="govuk-summary-list">
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">Name</dt>
    <dd class="govuk-summary-list__value">
      Sarah Philips
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          name
        </span>
      </a>
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">
      Date of birth
    </dt>
    <dd class="govuk-summary-list__value">
      5 January 1978
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          date of birth
        </span>
      </a>
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">Address</dt>
    <dd class="govuk-summary-list__value">
      72 Guild Street
      <br />
      London
      <br />
      SE23 6FH
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          address
        </span>
      </a>
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">
      Contact details
    </dt>
    <dd class="govuk-summary-list__value">
      <p class="govuk-body">07700 900457</p>
      <p class="govuk-body">
        sarah.phillips@example.com
      </p>
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          contact details
        </span>
      </a>
    </dd>
  </div>
</dl>

<SummaryList
  items={[
    {
      name: "Name",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden> name</VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: "Sarah Philips",
    },
    {
      name: "Date of birth",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden>
                {" "}
                date of birth
              </VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: "5 January 1978",
    },
    {
      name: "Address",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden>
                {" "}
                address
              </VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: (
        <Fragment>
          72 Guild Street
          <br />
          London
          <br />
          SE23 6FH
        </Fragment>
      ),
    },
    {
      name: "Contact details",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden>
                {" "}
                contact details
              </VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: (
        <Fragment>
          <p class="govuk-body">07700 900457</p>
          <p class="govuk-body">
            sarah.phillips@example.com
          </p>
        </Fragment>
      ),
    },
  ]}
/>

Props

Name	Type	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
defaultChecked	boolean
defaultValue	other
suppressContentEditableWarning	boolean
suppressHydrationWarning	boolean
accessKey	string
autoFocus	boolean
contentEditable	other
contextMenu	string
dir	string
draggable	other
hidden	boolean
lang	string
nonce	string
placeholder	string
slot	string
spellCheck	other
style	other
tabIndex	number
title	string
translate	enum
radioGroup	string
role	other
about	string
content	string
datatype	string
inlist	other
prefix	string
property	string
rel	string
resource	string
rev	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	other
onCopyCapture	other
onCut	other
onCutCapture	other
onPaste	other
onPasteCapture	other
onCompositionEnd	other
onCompositionEndCapture	other
onCompositionStart	other
onCompositionStartCapture	other
onCompositionUpdate	other
onCompositionUpdateCapture	other
onFocus	other
onFocusCapture	other
onBlur	other
onBlurCapture	other
onChange	other
onChangeCapture	other
onBeforeInput	other
onBeforeInputCapture	other
onInput	other
onInputCapture	other
onReset	other
onResetCapture	other
onSubmit	other
onSubmitCapture	other
onInvalid	other
onInvalidCapture	other
onLoad	other
onLoadCapture	other
onError	other
onErrorCapture	other
onKeyDown	other
onKeyDownCapture	other
onKeyPress	other
onKeyPressCapture	other
onKeyUp	other
onKeyUpCapture	other
onAbort	other
onAbortCapture	other
onCanPlay	other
onCanPlayCapture	other
onCanPlayThrough	other
onCanPlayThroughCapture	other
onDurationChange	other
onDurationChangeCapture	other
onEmptied	other
onEmptiedCapture	other
onEncrypted	other
onEncryptedCapture	other
onEnded	other
onEndedCapture	other
onLoadedData	other
onLoadedDataCapture	other
onLoadedMetadata	other
onLoadedMetadataCapture	other
onLoadStart	other
onLoadStartCapture	other
onPause	other
onPauseCapture	other
onPlay	other
onPlayCapture	other
onPlaying	other
onPlayingCapture	other
onProgress	other
onProgressCapture	other
onRateChange	other
onRateChangeCapture	other
onSeeked	other
onSeekedCapture	other
onSeeking	other
onSeekingCapture	other
onStalled	other
onStalledCapture	other
onSuspend	other
onSuspendCapture	other
onTimeUpdate	other
onTimeUpdateCapture	other
onVolumeChange	other
onVolumeChangeCapture	other
onWaiting	other
onWaitingCapture	other
onAuxClick	other
onAuxClickCapture	other
onClick	other
onClickCapture	other
onContextMenu	other
onContextMenuCapture	other
onDoubleClick	other
onDoubleClickCapture	other
onDrag	other
onDragCapture	other
onDragEnd	other
onDragEndCapture	other
onDragEnter	other
onDragEnterCapture	other
onDragExit	other
onDragExitCapture	other
onDragLeave	other
onDragLeaveCapture	other
onDragOver	other
onDragOverCapture	other
onDragStart	other
onDragStartCapture	other
onDrop	other
onDropCapture	other
onMouseDown	other
onMouseDownCapture	other
onMouseEnter	other
onMouseLeave	other
onMouseMove	other
onMouseMoveCapture	other
onMouseOut	other
onMouseOutCapture	other
onMouseOver	other
onMouseOverCapture	other
onMouseUp	other
onMouseUpCapture	other
onSelect	other
onSelectCapture	other
onTouchCancel	other
onTouchCancelCapture	other
onTouchEnd	other
onTouchEndCapture	other
onTouchMove	other
onTouchMoveCapture	other
onTouchStart	other
onTouchStartCapture	other
onPointerDown	other
onPointerDownCapture	other
onPointerMove	other
onPointerMoveCapture	other
onPointerUp	other
onPointerUpCapture	other
onPointerCancel	other
onPointerCancelCapture	other
onPointerEnter	other
onPointerEnterCapture	other
onPointerLeave	other
onPointerLeaveCapture	other
onPointerOver	other
onPointerOverCapture	other
onPointerOut	other
onPointerOutCapture	other
onGotPointerCapture	other
onGotPointerCaptureCapture	other
onLostPointerCapture	other
onLostPointerCaptureCapture	other
onScroll	other
onScrollCapture	other
onWheel	other
onWheelCapture	other
onAnimationStart	other
onAnimationStartCapture	other
onAnimationEnd	other
onAnimationEndCapture	other
onAnimationIteration	other
onAnimationIterationCapture	other
onTransitionEnd	other
onTransitionEndCapture	other
items	other	Items to be summarised

When to use this component

Use a summary list to show information as a list of key facts.

You can use it to display metadata like ‘Last updated’ with a date like ‘22 June 2018’, or to summarise a user’s responses at the end of a form like the check answers pattern.

Summary cards are a variant within this component. You can use summary cards to show multiple summary lists that describe the same type of thing, such as people. You can also add card actions that apply to the entire summary list.

When not to use this component

The summary list uses the description list (<dl>) HTML element, so only use it to present information that has a key and at least one value.

Do not use it for tabular data or a simple list of information or tasks, like a [task list]. For those use a <table>, <ul> or <ol>.

How it works

Each row of a summary list is made up of a:

‘key’ that’s a description or label of a piece of information, like
“Name”
‘value’ which is the piece of information itself, such as “John Smith”

You can show a single or multiple summary lists on a page. If you’re showing multiple summary lists on a page, you can add structure by using headings or summary cards.

Name

Sarah Philips

Date of birth

5 January 1978

Address

72 Guild Street
London
SE23 6FH

Contact details

07700 900457

sarah.phillips@example.com

HTML
React

<dl class="govuk-summary-list">
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">Name</dt>
    <dd class="govuk-summary-list__value">
      Sarah Philips
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">
      Date of birth
    </dt>
    <dd class="govuk-summary-list__value">
      5 January 1978
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">Address</dt>
    <dd class="govuk-summary-list__value">
      72 Guild Street
      <br />
      London
      <br />
      SE23 6FH
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">
      Contact details
    </dt>
    <dd class="govuk-summary-list__value">
      <p class="govuk-body">07700 900457</p>
      <p class="govuk-body">
        sarah.phillips@example.com
      </p>
    </dd>
  </div>
</dl>

<SummaryList
  items={[
    {
      name: "Name",
      children: "Sarah Philips",
    },
    {
      name: "Date of birth",
      children: "5 January 1978",
    },
    {
      name: "Address",
      children: (
        <Fragment>
          72 Guild Street
          <br />
          London
          <br />
          SE23 6FH
        </Fragment>
      ),
    },
    {
      name: "Contact details",
      children: (
        <Fragment>
          <p class="govuk-body">07700 900457</p>
          <p class="govuk-body">
            sarah.phillips@example.com
          </p>
        </Fragment>
      ),
    },
  ]}
/>

Adding actions to each row

You can add ‘row actions’ to a summary list. For example, you can help users go back and edit an answer by adding a ‘change’ link.

When navigating visually, the borders above and below each row help to show which row action is tied to which piece of information.

Assistive technology users, including those who use a screen reader, might hear a row action link out of context and might not know what it will do.

To give more context, add visually hidden text to the links. This means a screen reader user will hear the row action and the ‘key’ label for the information it will affect, like ‘Change name’ or ‘Change date of birth’.

Name

Sarah Philips

Change

Date of birth

5 January 1978

Change

Address

72 Guild Street
London
SE23 6FH

Change

Contact details

07700 900457

sarah.phillips@example.com

Change

HTML
React

<dl class="govuk-summary-list">
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">Name</dt>
    <dd class="govuk-summary-list__value">
      Sarah Philips
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          name
        </span>
      </a>
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">
      Date of birth
    </dt>
    <dd class="govuk-summary-list__value">
      5 January 1978
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          date of birth
        </span>
      </a>
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">Address</dt>
    <dd class="govuk-summary-list__value">
      72 Guild Street
      <br />
      London
      <br />
      SE23 6FH
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          address
        </span>
      </a>
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">
      Contact details
    </dt>
    <dd class="govuk-summary-list__value">
      <p class="govuk-body">07700 900457</p>
      <p class="govuk-body">
        sarah.phillips@example.com
      </p>
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          contact details
        </span>
      </a>
    </dd>
  </div>
</dl>

<SummaryList
  items={[
    {
      name: "Name",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden> name</VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: "Sarah Philips",
    },
    {
      name: "Date of birth",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden>
                {" "}
                date of birth
              </VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: "5 January 1978",
    },
    {
      name: "Address",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden>
                {" "}
                address
              </VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: (
        <Fragment>
          72 Guild Street
          <br />
          London
          <br />
          SE23 6FH
        </Fragment>
      ),
    },
    {
      name: "Contact details",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden>
                {" "}
                contact details
              </VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: (
        <Fragment>
          <p class="govuk-body">07700 900457</p>
          <p class="govuk-body">
            sarah.phillips@example.com
          </p>
        </Fragment>
      ),
    },
  ]}
/>

If you’re showing a mix of rows (where some rows include actions and some do not), add the govuk-summary-list__row--no-actions modifier class to the rows without actions. This is to ensure the bottom border is drawn correctly in some browsers.

Name

Sarah Philips

Date of birth

5 January 1978

Change

Address

72 Guild Street
London
SE23 6FH

Change

Contact details

07700 900457

sarah.phillips@example.com

Change

HTML
React

<dl class="govuk-summary-list">
  <div
    class="govuk-summary-list__row govuk-summary-list__row--no-actions"
  >
    <dt class="govuk-summary-list__key">Name</dt>
    <dd class="govuk-summary-list__value">
      Sarah Philips
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">
      Date of birth
    </dt>
    <dd class="govuk-summary-list__value">
      5 January 1978
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          date of birth
        </span>
      </a>
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">Address</dt>
    <dd class="govuk-summary-list__value">
      72 Guild Street
      <br />
      London
      <br />
      SE23 6FH
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          address
        </span>
      </a>
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">
      Contact details
    </dt>
    <dd class="govuk-summary-list__value">
      <p class="govuk-body">07700 900457</p>
      <p class="govuk-body">
        sarah.phillips@example.com
      </p>
    </dd>
    <dd class="govuk-summary-list__actions">
      <a class="govuk-link" href="#">
        Change
        <span class="govuk-visually-hidden">
          contact details
        </span>
      </a>
    </dd>
  </div>
</dl>

<SummaryList
  items={[
    {
      name: "Name",
      classModifiers: "no-actions",
      children: "Sarah Philips",
    },
    {
      name: "Date of birth",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden>
                {" "}
                date of birth
              </VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: "5 January 1978",
    },
    {
      name: "Address",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden>
                {" "}
                address
              </VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: (
        <Fragment>
          72 Guild Street
          <br />
          London
          <br />
          SE23 6FH
        </Fragment>
      ),
    },
    {
      name: "Contact details",
      actions: [
        {
          href: "#",
          children: (
            <Fragment>
              Change
              <VisuallyHidden>
                {" "}
                contact details
              </VisuallyHidden>
            </Fragment>
          ),
        },
      ],
      children: (
        <Fragment>
          <p class="govuk-body">07700 900457</p>
          <p class="govuk-body">
            sarah.phillips@example.com
          </p>
        </Fragment>
      ),
    },
  ]}
/>

Removing the borders

The summary list includes separating borders to help users by joining the information on each row and its action together.

Think carefully before you remove row borders. Borders help many users find and read information that’s laid out in rows, especially users who zoom in on pages or use assistive technologies to magnify their screen.

If your summary list does not have any actions, you can choose to remove the separating borders with the govuk-summary-list--no-border class.

Name

Sarah Philips

Date of birth

5 January 1978

Address

72 Guild Street
London
SE23 6FH

Contact details

07700 900457

sarah.phillips@example.com

HTML
React

<dl
  class="govuk-summary-list govuk-summary-list--no-border"
>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">Name</dt>
    <dd class="govuk-summary-list__value">
      Sarah Philips
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">
      Date of birth
    </dt>
    <dd class="govuk-summary-list__value">
      5 January 1978
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">Address</dt>
    <dd class="govuk-summary-list__value">
      72 Guild Street
      <br />
      London
      <br />
      SE23 6FH
    </dd>
  </div>
  <div class="govuk-summary-list__row">
    <dt class="govuk-summary-list__key">
      Contact details
    </dt>
    <dd class="govuk-summary-list__value">
      <p class="govuk-body">07700 900457</p>
      <p class="govuk-body">
        sarah.phillips@example.com
      </p>
    </dd>
  </div>
</dl>

<SummaryList
  classModifiers="no-border"
  items={[
    {
      name: "Name",
      children: "Sarah Philips",
    },
    {
      name: "Date of birth",
      children: "5 January 1978",
    },
    {
      name: "Address",
      children: (
        <Fragment>
          72 Guild Street
          <br />
          London
          <br />
          SE23 6FH
        </Fragment>
      ),
    },
    {
      name: "Contact details",
      children: (
        <Fragment>
          <p class="govuk-body">07700 900457</p>
          <p class="govuk-body">
            sarah.phillips@example.com
          </p>
        </Fragment>
      ),
    },
  ]}
/>

Summary cards

If you’re showing multiple summary lists on a page, you can show each list within a summary card. This lets you visually separate each summary list and give each a title and some actions.

Use summary cards when you need to show:

multiple summary lists that all describe the same type of thing, such as people
actions that will apply to all the items in a list

Summary cards are often used in case working systems to help users quickly view a set of information and related actions.

Do not use summary cards if you only need to show a small amount of related information. Use summary lists instead, and structure them with headings if needed.

If you’re showing summary cards at the end of a longer journey, you might want to familiarise the user with them earlier on — such as when the user reviews individual sections.

Card titles

Use the summary card’s header area to give each summary list a title.

Each title must be unique and help identify what the summary list describes. For example, this could be the name of a specific person, organisation or professional qualification.

Try to keep titles short and relevant. You can use one or two important values in the summary list — such as the first and last name of a person.

Lead tenant

Age: 38; Change age
Nationality: UK national resident in UK; Change nationality
Working situation: Part time – less than 30 hours a week; Change working situation

Person 2

Details known: Yes; Change whether details are known
Relationship to lead tenant: Partner; Change relationship to tenant
Age: 42; Change age
Working situation: Unable to work because of long-term sickness or disability; Change working situation

Person 3

Details known: Yes; Change whether details are known
Relationship to lead tenant: Child; Change relationship to tenant
Age: 7; Change age
Working situation: Child under 16; Change working situation

HTML
React

<div class="govuk-summary-card">
  <div class="govuk-summary-card__title-wrapper">
    <h2 class="govuk-summary-card__title">
      Lead tenant
    </h2>
  </div>
  <div class="govuk-summary-card__content">
    <dl class="govuk-summary-list">
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">Age</dt>
        <dd class="govuk-summary-list__value">38</dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              age
            </span>
          </a>
        </dd>
      </div>
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Nationality
        </dt>
        <dd class="govuk-summary-list__value">
          UK national resident in UK
        </dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              nationality
            </span>
          </a>
        </dd>
      </div>
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Working situation
        </dt>
        <dd class="govuk-summary-list__value">
          Part time – less than 30 hours a week
        </dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              working situation
            </span>
          </a>
        </dd>
      </div>
    </dl>
  </div>
</div>
<div class="govuk-summary-card">
  <div class="govuk-summary-card__title-wrapper">
    <h2 class="govuk-summary-card__title">
      Person 2
    </h2>
  </div>
  <div class="govuk-summary-card__content">
    <dl class="govuk-summary-list">
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Details known
        </dt>
        <dd class="govuk-summary-list__value">Yes</dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              whether details are known
            </span>
          </a>
        </dd>
      </div>
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Relationship to lead tenant
        </dt>
        <dd class="govuk-summary-list__value">
          Partner
        </dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              relationship to tenant
            </span>
          </a>
        </dd>
      </div>
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">Age</dt>
        <dd class="govuk-summary-list__value">42</dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              age
            </span>
          </a>
        </dd>
      </div>
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Working situation
        </dt>
        <dd class="govuk-summary-list__value">
          Unable to work because of long-term sickness
          or disability
        </dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              working situation
            </span>
          </a>
        </dd>
      </div>
    </dl>
  </div>
</div>
<div class="govuk-summary-card">
  <div class="govuk-summary-card__title-wrapper">
    <h2 class="govuk-summary-card__title">
      Person 3
    </h2>
  </div>
  <div class="govuk-summary-card__content">
    <dl class="govuk-summary-list">
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Details known
        </dt>
        <dd class="govuk-summary-list__value">Yes</dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              whether details are known
            </span>
          </a>
        </dd>
      </div>
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Relationship to lead tenant
        </dt>
        <dd class="govuk-summary-list__value">
          Child
        </dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              relationship to tenant
            </span>
          </a>
        </dd>
      </div>
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">Age</dt>
        <dd class="govuk-summary-list__value">7</dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              age
            </span>
          </a>
        </dd>
      </div>
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Working situation
        </dt>
        <dd class="govuk-summary-list__value">
          Child under 16
        </dd>
        <dd class="govuk-summary-list__actions">
          <a class="govuk-link" href="#">
            Change
            <span class="govuk-visually-hidden">
              working situation
            </span>
          </a>
        </dd>
      </div>
    </dl>
  </div>
</div>

<>
  <SummaryCard title="Lead tenant">
    <SummaryList
      items={[
        {
          name: "Age",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    age
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children: "38",
        },
        {
          name: "Nationality",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    nationality
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children: "UK national resident in UK",
        },
        {
          name: "Working situation",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    working situation
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children:
            "Part time – less than 30 hours a week",
        },
      ]}
    />
  </SummaryCard>
  <SummaryCard title="Person 2">
    <SummaryList
      items={[
        {
          name: "Details known",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    whether details are known
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children: "Yes",
        },
        {
          name: "Relationship to lead tenant",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    relationship to tenant
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children: "Partner",
        },
        {
          name: "Age",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    age
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children: "42",
        },
        {
          name: "Working situation",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    working situation
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children:
            "Unable to work because of long-term sickness or disability",
        },
      ]}
    />
  </SummaryCard>
  <SummaryCard title="Person 3">
    <SummaryList
      items={[
        {
          name: "Details known",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    whether details are known
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children: "Yes",
        },
        {
          name: "Relationship to lead tenant",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    relationship to tenant
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children: "Child",
        },
        {
          name: "Age",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    age
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children: "7",
        },
        {
          name: "Working situation",
          actions: [
            {
              href: "#",
              children: (
                <Fragment>
                  Change
                  <VisuallyHidden>
                    {" "}
                    working situation
                  </VisuallyHidden>
                </Fragment>
              ),
            },
          ],
          children: "Child under 16",
        },
      ]}
    />
  </SummaryCard>
</>

Adding card actions

You can add card actions in the header, which will be shown after the summary card’s title.

For example, if you have multiple rows with “change” actions that all take the user to the same place, you can show a single “change” card action instead. This helps avoid repeating the same row action on every row.

Card actions are shown in bold text to make them visually distinct from row actions — and help alert the user that the card action will affect the entire summary card.

Write link text for card actions to tell the user what the card action will do and that it will apply to the entire summary card. It should also be as short as possible, usually 2 words.

Example card actions include:

Remove tenant
Edit qualification
Update issue
Approve application
Cancel order

Keep it short and do not add more than 2 to 3 actions in a header.

If a card action cannot easily be undone or might have serious consequences, consider adding a warning or asking the user for confirmation.

University of Gloucestershire

Course: English (3DMD)
PGCE with QTS full time
Location: School name
Road, City, SW1 1AA

University of Bristol

Course: English (Q3X1)
PGCE with QTS full time
Location: School name
Road, City, SW2 1AA

HTML
React

<div class="govuk-summary-card">
  <div class="govuk-summary-card__title-wrapper">
    <h2 class="govuk-summary-card__title">
      University of Gloucestershire
    </h2>
    <ul class="govuk-summary-card__actions">
      <li
        class="govuk-summary-card__actions__item govuk-summary-card__actions__item--active"
      >
        <a
          class="govuk-summary-card__actions__link"
          href="#"
        >
          Delete choice
          <span class="govuk-visually-hidden">
            of University of Gloucestershire
          </span>
        </a>
      </li>
      <li
        class="govuk-summary-card__actions__item govuk-summary-card__actions__item--active"
      >
        <a
          class="govuk-summary-card__actions__link"
          href="#"
        >
          Withdraw
          <span class="govuk-visually-hidden">
            from University of Gloucestershire
          </span>
        </a>
      </li>
    </ul>
  </div>
  <div class="govuk-summary-card__content">
    <dl class="govuk-summary-list">
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Course
        </dt>
        <dd class="govuk-summary-list__value">
          English (3DMD)
          <br />
          PGCE with QTS full time
        </dd>
      </div>
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Location
        </dt>
        <dd class="govuk-summary-list__value">
          School name
          <br />
          Road, City, SW1 1AA
        </dd>
      </div>
    </dl>
  </div>
</div>
<div class="govuk-summary-card">
  <div class="govuk-summary-card__title-wrapper">
    <h2 class="govuk-summary-card__title">
      University of Bristol
    </h2>
    <ul class="govuk-summary-card__actions">
      <li
        class="govuk-summary-card__actions__item govuk-summary-card__actions__item--active"
      >
        <a
          class="govuk-summary-card__actions__link"
          href="#"
        >
          Delete choice
          <span class="govuk-visually-hidden">
            of University of Bristol
          </span>
        </a>
      </li>
      <li
        class="govuk-summary-card__actions__item govuk-summary-card__actions__item--active"
      >
        <a
          class="govuk-summary-card__actions__link"
          href="#"
        >
          Withdraw
          <span class="govuk-visually-hidden">
            from University of Bristol
          </span>
        </a>
      </li>
    </ul>
  </div>
  <div class="govuk-summary-card__content">
    <dl class="govuk-summary-list">
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Course
        </dt>
        <dd class="govuk-summary-list__value">
          English (Q3X1)
          <br />
          PGCE with QTS full time
        </dd>
      </div>
      <div class="govuk-summary-list__row">
        <dt class="govuk-summary-list__key">
          Location
        </dt>
        <dd class="govuk-summary-list__value">
          School name
          <br />
          Road, City, SW2 1AA
        </dd>
      </div>
    </dl>
  </div>
</div>

<>
  <SummaryCard
    title="University of Gloucestershire"
    actions={[
      {
        href: "#",
        children: (
          <Fragment>
            Delete choice
            <VisuallyHidden>
              {" "}
              of University of Gloucestershire
            </VisuallyHidden>
          </Fragment>
        ),
      },
      {
        href: "#",
        children: (
          <Fragment>
            Withdraw
            <VisuallyHidden>
              {" "}
              from University of Gloucestershire
            </VisuallyHidden>
          </Fragment>
        ),
      },
    ]}
  >
    <SummaryList
      items={[
        {
          name: "Course",
          children: (
            <Fragment>
              English (3DMD)
              <br />
              PGCE with QTS full time
            </Fragment>
          ),
        },
        {
          name: "Location",
          children: (
            <Fragment>
              School name
              <br />
              Road, City, SW1 1AA
            </Fragment>
          ),
        },
      ]}
    />
  </SummaryCard>
  <SummaryCard
    title="University of Bristol"
    actions={[
      {
        href: "#",
        children: (
          <Fragment>
            Delete choice
            <VisuallyHidden>
              {" "}
              of University of Bristol
            </VisuallyHidden>
          </Fragment>
        ),
      },
      {
        href: "#",
        children: (
          <Fragment>
            Withdraw
            <VisuallyHidden>
              {" "}
              from University of Bristol
            </VisuallyHidden>
          </Fragment>
        ),
      },
    ]}
  >
    <SummaryList
      items={[
        {
          name: "Course",
          children: (
            <Fragment>
              English (Q3X1)
              <br />
              PGCE with QTS full time
            </Fragment>
          ),
        },
        {
          name: "Location",
          children: (
            <Fragment>
              School name
              <br />
              Road, City, SW2 1AA
            </Fragment>
          ),
        },
      ]}
    />
  </SummaryCard>
</>

Research on this component

This component was developed and tested by the Government Digital Service as part of the check answers pattern.

The Department for Education contributed the summary card. It’s being used in some of their services, such as:

apply for teacher training, used by the general public
register trainee teachers, used by people that work for training providers

The summary card is also used in services run by other departments, such us:

manage supervisions (Ministry of Justice)
submit social housing lettings and sales data (Department for Levelling Up, Housing & Communities)

Next steps

We still want to learn more about when this component works well.

If you use this component in your service, we’d like to hear about how you use the summary list and summary card, as well as any research findings you might have.