| Name | Type | Required | Description |
|---|---|---|---|
| summaries | Array<Summaries> |
true | An array of summaries |
| classes | string | false | Classes to add to the summary component |
| variant | string | false | Can be set to card or hub to use those variants of the summary |
| Name | Type | Required | Description |
|---|---|---|---|
| groups | Array<SummaryGroup> |
true | An array of groups within a summary |
| title | string | false | The h2 title heading for a group of summaries |
| Name | Type | Required | Description |
|---|---|---|---|
| rows | Array<SummaryRow> |
true (unless placeholderText set) |
An array of rows within a group |
| placeholderText | string | true (unless rows set) |
A message to be shown as a placeholder if there are no rows in the summary |
| title | string | false (true if variant is set to card ) |
The title heading for a summary within a group |
| id | string | false | The HTML id of the group |
| summaryLink | Array<SummaryLink> |
false | Settings for the summary link used to a new row to the summary |
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | The HTML id of the row |
| itemsList | Array<SummaryRowItem> |
true | An array of items for the row |
| title | string | false | The title for the row |
| error | boolean | false | Set to “true” display an error on a row |
| errorMessage | string | false | The error message for the row |
| total | boolean | false | Set to “true” to display row as a calculated total of previous rows |
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | id of the action links |
| iconType | string | false | Adds an icon before the row title, by setting the icon type |
| iconVisuallyHiddenText | string | false | Visually hidden text in a span under the icon to add more context for screen readers |
| title | string | false | The title for the row item |
| titleAttributes | object | false | HTML attributes (for example, data attributes) to add to the row title |
| valueList | Array<SummaryValue> |
false | An array of value(s) for the row item |
| actions | Array<SummaryAction> |
false | Settings for the row action links |
| attributes | object | false | HTML attributes (for example, data attributes) to add to the row item |
| Name | Type | Required | Description |
|---|---|---|---|
| text | string | true | Text for the value |
| other | string | false | Text for a Nested value for displaying an “other” input answer |
| Name | Type | Required | Description |
|---|---|---|---|
| text | string | true | Text for the action link |
| url | string | true | The URL for the HTML href attribute of the link used to change the value of the row item |
| attributes | object | false | HTML attributes (for example, data attributes) to add to the action link |
| visuallyHiddenText | string | false | Visually hidden text in a span under the action link to add more context for screen readers, , defaults the text in text param |
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | true | The URL for the HTML href attribute of the summary link |
| text | string | true | The text for the summary link |
| attributes | object | false | HTML attributes (for example, data attributes) to add to the summary link |