Review Layout

A list of read-only fields used to show information to the user for review.

review {
    title = "Please review your transfer"
    fields {
        field {
            label = "Recipient"
            value = "Florence Jones"
        }
        field {
            label = "Amount"
            value = "$6550"
        }
        field {
            label = "To be sent"
            value = "July 21, 2024"
        }
    }
    callToAction {
        title = "Edit"
        behavior = ActionBehavior.build {
            action {
                url = "/edit"
            }
        }
    }
}

When to use

When the users attention is meant to be on the values, rather than the labels. For example, when the user is being asked to check a number of fields that they have previously entered.

When not to use

When the primary action of the step is tied to an individual item, consider using a Decision Layout instead.
When the content being displayed represents separate entities of the same category, consider using a List Layout instead.
If the focus is on the labels rather than the values, consider using a List Layout instead.

Properties

Property	Type	Required	Description
`analyticsId`	String	No	An optional identifier to be used in analytics tracking.
`callToAction`	ReviewLayout.CallToAction	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`.
`tags`	Array<String>	No	An optional list of identifiers used to configure renderers.
`title`	String	No	Title for the review block.
`type`	String	Yes	It must be `review`.

Field

A single field in a Review Layout.

Properties

Property	Type	Required	Description
`additionalInfo`	AdditionalInfo	No	Additional information to be displayed to the user, with optional interactivity.
`analyticsId`	String	No	An optional identifier to be used in analytics tracking.
`callToAction`	ReviewLayout.CallToAction	No	A titled Behavior, associated with a specific field, and which can be performed by the user
`help`	Help	No	Provide additional help information to the user.
`icon`	Icon	No	An icon to represent the field.
`image`	Image	No	An image to represent the field.
`inlineAlert`	InlineAlert	No	An alert that will be displayed inline with the item.
`label`	String	Yes	The user-facing label.
`media`	Media	No	A media object (avatar, icon, image) which the client can use to represent this field.
`rawValue`	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.
`tag`	String	No	An optional identifier to be used in custom renderers. ⚠️ Deprecated - Please use 'tags' instead
`tags`	Array<String>	No	An optional list of identifiers used to configure renderers.
`value`	String	Yes	The user-facing value.

Call To Action

The call to action configuration used by Review Layout or individual fields (Field). For example, it could be used to provide an edit action.

Properties

Property	Type	Required	Description
`accessibilityDescription`	String	No	A description of the call to action to be used by screen readers.
`action`	Action	No	The Action which should be performed. ⚠️ Deprecated - Please use `behavior` with an action instead.
`behavior`	Behavior	Yes	The Behavior that should be performed when user interacts with call to action.
`context`	Context	No	The semantics of the call-to-action button. Defaults to neutral.
`title`	String	Yes	A user-facing title.