⚠️ Warning! List Layout is experimental and may be changed in the future without notice.
A list of read-only fields displaying information with optional images or icons for the user.
| Property | Type | Required | Description |
|---|---|---|---|
callToAction | ListLayout.CallToAction | No | A titled call to action which can be performed by the user. |
control | String | No | Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored. |
items | Array<ListLayout.Item> | Yes | Array of items. |
margin | Size | No | The vertical margin to apply after this component. Defaults to md. |
title | String | No | The user-facing title. |
type | String | Yes | It must be list. |
A single entry in a List Layout.
| Property | Type | Required | Description |
|---|---|---|---|
icon | Icon | No | An icon to represent the item. |
image | Image | No | An image to represent the option. |
subtitle | String | No | A user-facing subtitle. |
subvalue | String | No | A user-facing subvalue. |
| String | No | An optional identifier to be used in custom renderers.
⚠️ Experimental - This may be changed in the future without notice. |
title | String | No | A user-facing title. |
value | String | No | A user-facing value. |
The call to action configuration used by List Layout. For example, it could be used to provide an edit action.
| Property | Type | Required | Description |
|---|---|---|---|
accessibilityDescription | String | No | A description of the call to action to be used by screen readers. |
behavior | Behavior | Yes | Behavior that should be performed when user interacts with call to action. |
title | String | Yes | A user-facing title. |