.dependabot
.github
.storybook
__mocks__
cypress
dev-test
functions
img
packages
scripts
website
content
blog
docs
widgets
boolean.md
code.md
color.md
date.md
datetime.md
file.md
hidden.md
image.md
list.md
map.md
markdown.md
number.md
object.md
relation.md
select.md
string.md
text.md
add-to-your-site.md
architecture.md
azure-backend.md
backends-overview.md
beta-features.md
bitbucket-backend.md
cloudinary.md
collection-types.md
configuration-options.md
contributor-guide.md
custom-widgets.md
customization.md
deploy-preview-links.md
examples.md
external-oauth-clients.md
gatsby.md
git-gateway-backend.md
github-backend.md
gitlab-backend.md
gridsome.md
hugo.md
intro.md
jekyll.md
middleman.md
netlify-large-media.md
nextjs.md
nuxt.md
open-authoring.md
releases.md
start-with-a-template.md
test-backend.md
uploadcare.md
widgets.md
writing-style-guide.md
pages
.keep
data
src
static
.babelrc
.gitignore
.markdownlint.json
.nvmrc
README.md
gatsby-browser.js
gatsby-config.js
gatsby-node.js
netlify.toml
package.json
site.yml
yarn.lock
.all-contributorsrc
.editorconfig
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
.prettierrc
.stylelintrc
.vale.ini
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
babel.config.js
cms.png
commitlint.config.js
cypress.json
jest.config.js
lerna.json
netlify.toml
package.json
renovate.json
setupTestFramework.js
tsconfig.json
yarn.lock
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
---
|
|
title: object
|
|
label: 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`, 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"
|
|
name: "profile"
|
|
widget: "object"
|
|
summary: '{{fields.name}}: {{fields.birthdate}}'
|
|
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"}
|
|
```
|