static-cms/website/content/docs/widget-object.mdx

41 lines
1.4 KiB
Plaintext
Raw Normal View History

2022-09-30 11:39:35 -04:00
---
group: Widgets
title: Object
weight: 21
2022-09-30 11:39:35 -04:00
---
The object widget allows you to group multiple widgets together, nested under a single field. You can choose any widget as a child of an object widget—even other objects.
* **Name:** `object`
* **UI:** a field containing one or more child widgets
* **Data type:** list of child widget values
* **Options:**
* `default`: you can set defaults within each sub-field's configuration
* `collapsed`: if added and labeled `true`, collapse the widget's content by default
* `summary`: specify the label displayed when the object is collapsed
* `fields`: (**required**) a nested list of widget fields to include in your widget
* **Example:**
```yaml
- label: "Profile"
title: "profile"
2022-09-30 11:39:35 -04:00
widget: "object"
summary: '{{fields.name}}: {{fields.birthdate}}'
fields:
- {label: "Public", title: "public", widget: "boolean", default: true}
- {label: "Name", title: "name", widget: "string"}
2022-09-30 11:39:35 -04:00
- label: "Birthdate"
title: "birthdate"
2022-09-30 11:39:35 -04:00
widget: "date"
default: ""
format: "MM/DD/YYYY"
- label: "Address"
title: "address"
2022-09-30 11:39:35 -04:00
widget: "object"
collapsed: true
fields:
- {label: "Street Address", title: "street", widget: "string"}
- {label: "City", title: "city", widget: "string"}
- {label: "Postal Code", title: "post-code", widget: "string"}
2022-09-30 11:39:35 -04:00
```