A list of read-only fields used to show information to the user for review.
| Property | Type | Required | Description |
|---|---|---|---|
| No | A titled 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. |
fields | Array<ReviewLayout.Field> | Yes | The fields to be reviewed. |
margin | Size | No | The vertical margin to apply after this component. Defaults to md. |
title | String | No | Title for the review block. |
type | String | Yes | It must be review. |
A single field in a Review Layout
| Property | Type | Required | Description |
|---|---|---|---|
| No | Provide additional help information to the user.
| |
label | String | Yes | The user-facing label. |
| String | No | The value of the field without any formatting applied. This can be used when you display a formatted value to the user, but want to provide an unformatted value to the client for other uses, for example when copying the value to the clipboard.
|
| String | No | An optional identifier to be used in custom renderers.
⚠️ Experimental - This may be changed in the future without notice. |
value | String | Yes | The user-facing value. |
Adds an Action to the review layout. For example, it could be used to provide an edit action.
| Property | Type | Required | Description |
|---|---|---|---|
action | Action | Yes | The Action which should be performed. |
title | String | Yes | A user-facing title. |