Container Field

Amadeus

Last updated August 28, 2021

Editing UI Widget

This field is visualOnly, which means that it has no impact on the data structure of your content and as such is not interactive. Instead it simply renders its sub-fields either as a row, a column with a border, or a collapsible section according to its options.

Output Format

This field is only visual and as such carries no value.

Options

The following options are available for this field (default values shown):

{
  "collapsible": false,
  "collapseByDefault": false,
  "row": false,
  "bordered": false
}

collapsible: whether or not to render the sub-fields in a collapsible section. Implicitly assumes bordered to be true
collapseByDefault: whether or not the collapsible sections should be collapsed before user interaction. Has no effect if collapsible is not true
row: whether or not to display the sub-fields as a row
bordered: whether or not to visually group the enclosed fields by drawing a subtle border around them

Validation

Since this field is purely visual and has no content, it also has no validation options.

Notes

Unlike Field Group, Rows and Columns fields, the fields within a Container field are intentionally not namespaced to it, i.e. they belong to the parent field as far as the content data structure is concerned. For that reason, it is important to ensure their keys are unique, especially when nesting Containers within each other.

If you notice any strange behaviour or experience errors, it’s likely due to two fields having the same key.

Using a Container field as the top-level field of a Custom Field allows you to define a centrally managed interface that can be added to other Schemas as top-level fields.

If you are instead looking for a way to model an object or group fields under a common key, you might be looking for the Field Group field instead.

Version History

Version at launch: 1