static-cms/website/content/docs/widgets/object.md

---
label: "Object"
title: object
---

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`, the widget's content is collapsed by default
  - `fields`: (**required**) a nested list of widget fields to include in your widget
- **Example:**
    ```yaml
    - label: "Profile"
      name: "profile"
      widget: "object"
      fields:
        - {label: "Public", name: "public", widget: "boolean", default: true}
        - {label: "Name", name: "name", widget: "string"}
        - label: "Birthdate"
          name: "birthdate"
          widget: "date"
          default: ""
          format: "MM/DD/YYYY"
        - label: "Address"
          name: "address"
          widget: "object"
          collapsed: true
          fields: 
            - {label: "Street Address", name: "street", widget: "string"}
            - {label: "City", name: "city", widget: "string"}
            - {label: "Postal Code", name: "post-code", widget: "string"}
    ```
New design for the widgets section in the docs (#866) * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Rebased and updated the info according to @verythorough contribution * Fixing the yaml codes for the relation and select widget sections * Merging with widgets.md and app.j * Fixing some silly mistakes (sorry!) * Following @verythorough contributions :) * Adding the markdown widget and fixing the widgets container background * Adding the URL functionality and myself as a contributor :) * Adding myself as a contributor :) 2018-01-03 20:14:15 -02:00			`---`
docs(fix): revert prettier formatting on markdown files (#1612) Prettier formatting our markdown files is causing bugs because of the differences between Gatsby's parser and Prettier's. Also, Prettier formats the inline code-blocks containing example CMS configs, but the formatting it uses doesn't really make much sense or match the suggested CMS config style. It doesn't actually make much sense to format the docs anyway, since we use the CMS itself to edit/generate them. 2018-08-14 11:33:13 -06:00			`label: "Object"`
docs: make widget docs editable (#1782) * make widget docs editable * update widget doc frontmatter keys * improve docs preview * fix formatting * fix preview * add prism highlighting for previews * fix formatting * restore cms branch 2018-10-01 20:00:57 -04:00			`title: object`
New design for the widgets section in the docs (#866) * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Rebased and updated the info according to @verythorough contribution * Fixing the yaml codes for the relation and select widget sections * Merging with widgets.md and app.j * Fixing some silly mistakes (sorry!) * Following @verythorough contributions :) * Adding the markdown widget and fixing the widgets container background * Adding the URL functionality and myself as a contributor :) * Adding myself as a contributor :) 2018-01-03 20:14:15 -02: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
feat(widget-object): add collapsed option to collapse object by default (#3606) 2020-04-15 13:46:09 +02:00			- `collapsed`: if added and labeled `true`, the widget's content is collapsed by default
New design for the widgets section in the docs (#866) * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Rebased and updated the info according to @verythorough contribution * Fixing the yaml codes for the relation and select widget sections * Merging with widgets.md and app.j * Fixing some silly mistakes (sorry!) * Following @verythorough contributions :) * Adding the markdown widget and fixing the widgets container background * Adding the URL functionality and myself as a contributor :) * Adding myself as a contributor :) 2018-01-03 20:14:15 -02:00			- `fields`: (required) a nested list of widget fields to include in your widget
			`- Example:`
docs(fix): widget example code layout on Site (#1606) * Fix widget example layout * Stop running MarkDown through Prettier. 2018-08-14 07:37:07 -07:00			```yaml
docs(fix): revert prettier formatting on markdown files (#1612) Prettier formatting our markdown files is causing bugs because of the differences between Gatsby's parser and Prettier's. Also, Prettier formats the inline code-blocks containing example CMS configs, but the formatting it uses doesn't really make much sense or match the suggested CMS config style. It doesn't actually make much sense to format the docs anyway, since we use the CMS itself to edit/generate them. 2018-08-14 11:33:13 -06:00			`- label: "Profile"`
			`name: "profile"`
			`widget: "object"`
docs(fix): widget example code layout on Site (#1606) * Fix widget example layout * Stop running MarkDown through Prettier. 2018-08-14 07:37:07 -07:00			`fields:`
docs(fix): revert prettier formatting on markdown files (#1612) Prettier formatting our markdown files is causing bugs because of the differences between Gatsby's parser and Prettier's. Also, Prettier formats the inline code-blocks containing example CMS configs, but the formatting it uses doesn't really make much sense or match the suggested CMS config style. It doesn't actually make much sense to format the docs anyway, since we use the CMS itself to edit/generate them. 2018-08-14 11:33:13 -06:00			`- {label: "Public", name: "public", widget: "boolean", default: true}`
			`- {label: "Name", name: "name", widget: "string"}`
			`- label: "Birthdate"`
			`name: "birthdate"`
			`widget: "date"`
			`default: ""`
			`format: "MM/DD/YYYY"`
			`- label: "Address"`
			`name: "address"`
			`widget: "object"`
feat(widget-object): add collapsed option to collapse object by default (#3606) 2020-04-15 13:46:09 +02:00			`collapsed: true`
docs(fix): revert prettier formatting on markdown files (#1612) Prettier formatting our markdown files is causing bugs because of the differences between Gatsby's parser and Prettier's. Also, Prettier formats the inline code-blocks containing example CMS configs, but the formatting it uses doesn't really make much sense or match the suggested CMS config style. It doesn't actually make much sense to format the docs anyway, since we use the CMS itself to edit/generate them. 2018-08-14 11:33:13 -06:00			`fields:`
			`- {label: "Street Address", name: "street", widget: "string"}`
			`- {label: "City", name: "city", widget: "string"}`
			`- {label: "Postal Code", name: "post-code", widget: "string"}`
docs(fix): widget example code layout on Site (#1606) * Fix widget example layout * Stop running MarkDown through Prettier. 2018-08-14 07:37:07 -07:00			```