Skip to main content

betaThis is a new capability. Help us improve it and give your feedback on Slack.

List

Display a GOV.UK-styled list sourced from a named list definition.

Preview

What you need to do

  • Option 1
  • Option 2
  • Option 3

JSON definition

{
"type": "List",
"name": "fieldName",
"title": "Question title",
"hint": "",
"list": "",
"options": {}
}

Properties

PropertyTypeRequiredDescription
hintstringNoHint text displayed below the field label to help the user answer the question.
liststringYesName of a list definition that provides the options to display. See list schema for the list definition format.

Options

PropertyTypeRequiredDescription
boldbooleanNoWhen true, displays option labels in bold.
classesstringNoAdditional CSS classes applied to the component.
hideTitlebooleanNoWhen true, hides the component or section title.
typestringNoDisplay style for the list: 'bulleted' or 'numbered'.