A schema which merges the value of its child schemas.
Use an allOf schema to represent a form section where the submission payload is the result of merging the allOf's child schemas.
This can be useful if you need to have one object in your submission payload, but want to split the properties into two or more sections.
| Property | Type | Required | Description |
|---|---|---|---|
$id | String | No | A unique id which can be used to refer to the schema. |
| String | No | Additional information to be displayed to the user.
|
alert | AlertLayout | No | Configure an alert which will be displayed above the UI for this schema. This can be used to provide warnings or additional information to the user, but shouldn't be used for validation. For client-side validation please see the validation available on each schema type, or see Validate Async and Action for server-side validation. |
allOf | Array<Schema> | Yes | The child schemas of the allOf. The values of these schemas will be merged from first to last to create the submission value. |
analyticsId | String | No | An internal id which is attached to analytics events relating to the schema. It allows you to override $id during event emission, it is not user-facing and does not have to be unique within the step. |
control | String | No | An identifier which can be used to request the client use a particular UI control to represent this schema. |
description | String | No | A user-facing description for the schema. |
disabled | Boolean | No | If true, the UI for this schema will not accept input, but the corresponding data will still be submitted. Defaults to false. |
hidden | Boolean | No | If true, no UI will be shown to the user for this schema, but the corresponding data will still be submitted. Defaults to false. |
icon | Icon | No | An icon which the client can use to represent this entity. |
image | Image | No | An image which the client can use to represent this entity. |
| No | An alert that will be displayed inline with the item.
| |
keywords | Array<String> | No | A list of keywords that can be used when searching or filtering items in a One Of Schema. Only applies when this schema is child schema in a One Of Schema. |
media | Media | No | A media object which the client can use to represent this entity. |
summary | Summary.Provider | No | Configure how this schema will be summarised when included in an Array Schema. |
| No | An object containing two strings representing two user-facing values. One being clearly more important than the other.
| |
| Array<String> | No | An optional list of identifiers used to configure renderers.
|
title | String | No | A user-facing title for the schema. |
