name: Summary list
description: Use the summary list to summarise information, for example, a user’s responses at the end of a form.
body:  This component extends the [Summary list component in the Design System](https://design-system.service.gov.uk/components/summary-list/) allowing the rendering of multiple groups of lists, and actions at the group level.
accessibility_criteria: |
  Action links in the component must:

  * indicate what the action refers to (e.g. Change _name_)
shared_accessibility_criteria:
  - link
govuk_frontend_components:
  - summary-list
examples:
  default:
    data: &default-example-data
      title: "Title, summary and body"
      items:
      - field: "Title"
        value: "Ethical standards for public service providers"
      - field: "Summary"
        value: "Find out more about our reviews on the subject of ethical standards for public service providers, including our 2014 report, 2015 guidance and 2018 follow-up publication."
      - field: "Body"
        value: "After the government decided in 2013 to expand the remit of the Committee to include public service providers, the Committee on Standards in Public Life produced our first report on the issue: Ethical Standards for Providers of Public Services in 2014."

  without_title:
    data:
      items:
      - field: "Title"
        value: "Ethical standards for public service providers"
      - field: "Summary"
        value: "Find out more about our reviews on the subject of ethical standards for public service providers, including our 2014 report, 2015 guidance and 2018 follow-up publication."

  without_borders:
    data:
      <<: *default-example-data
      borderless: true

  with_edit_on_section:
    data:
      <<: *default-example-data
      edit:
        href: "edit-title-summary-body"
        data_attributes:
          gtm: "edit-title-summary-body"

  with_delete_on_section:
    data:
      <<: *default-example-data
      delete:
        href: "delete-title-summary-body"
        data_attributes:
          gtm: "delete-title-summary-body"

  with_edit_and_delete_on_section:
    data:
      <<: *default-example-data
      edit:
        href: "edit-title-summary-body"
        data_attributes:
          gtm: "edit-title-summary-body"
      delete:
        href: "delete-title-summary-body"
        data_attributes:
          gtm: "delete-title-summary-body"

  with_custom_section_heading:
    data:
      <<: *default-example-data
      heading_level: 2
      heading_size: l

  with_custom_link_on_section:
    description: |
      Take care that the provided `link_text` still makes sense to screen readers when combined with the title.
      For instance, `Reorder` link text and `Items` title becomes `Reorder Items`, which reads fine, but link text
      of `Summary` would read as `Summary Items`, which does not make sense.
    data:
      edit:
        href: "custom-link"
        link_text: "Reorder"
      title: "Items"
      items:
      - field: "Item 1"
        value: "Value 2"
      - field: "Item 2"
        value: "Value 2"
      - field: "Item 3"
        value: "Value 3"

  with_edit_on_individual_items:
    description: The link text can be optionally modified using the 'link_text' parameter, as for the edit link in previous examples.
    data:
      title: "Title, summary and body"
      items:
      - field: "Title"
        value: "Ethical standards for public service providers"
        edit:
          href: "edit-title"
          text: "Edit"
          data_attributes:
            gtm: "edit-title"
      - field: "Summary"
        value: "Find out more about our reviews on the subject of ethical standards for public service providers, including our 2014 report, 2015 guidance and 2018 follow-up publication."
        edit:
          href: "edit-summary"
        delete:
          href: "delete-summary"
      - field: "Body"
        value: "After the government decided in 2013 to expand the remit of the Committee to include public service providers, the Committee on Standards in Public Life produced our first report on the issue: Ethical Standards for Providers of Public Services in 2014."
        edit:
          href: "edit-body"
          link_text: "Edit"
        delete:
          href: "delete-body"
          link_text: "Remove"

  with_block:
    description: Use the summary list with a block when you need to show an empty state message or load another component.
    data:
      title: "Topics"
      block: |
        <p class="govuk-body">No topics specified for this document.</p>