A container for a group of layout components topped with a section header.
section {
title = "Primary Tenant"
components {
markdown {
content = "Simon Claw"
}
}
}
section {
title = "Co-applicant"
components {
markdown {
content = "Tim Cheese"
}
}
callToAction {
title = "Edit"
accessibilityDescription = "This is an edit button to edit co-applicant details"
behavior = ActionBehavior.build {
action {
url = "/edit"
method = HttpMethod.POST
}
}
}
}When to use
- When content is grouped under a shared title, or for accessibility reasons.
When not to use
- When the content is a single layout which has its own title, consider using that layout directly instead. For example, Decision Layout, Review Layout, or List Layout.
| Property | Type | Required | Description |
|---|---|---|---|
analyticsId | String | No | An optional identifier to be used in analytics tracking. |
callToAction | SectionLayout.CallToAction | No | A titled call to action which can be performed by the user. |
components | Array<Layout> | Yes | The contained components. |
control | String | No | Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored. |
margin | Size | No | The vertical margin to apply after this component. Defaults to md. |
| Array<String> | No | An optional list of identifiers used to configure renderers.
|
title | String | Yes | The user-facing title. |
type | String | Yes | It must be 'section'. |
The call to action configuration used by Section Layout.
| Property | Type | Required | Description |
|---|---|---|---|
accessibilityDescription | String | No | A description of the call to action to be used by screen readers. |
behavior | Behavior | Yes | The Behavior that should be performed when user interacts with call to action. |
| No | The semantics of the call-to-action button. Defaults to neutral.
| |
title | String | Yes | A user-facing title. |
