Developer ReferenceConfiguration File

groups[*]

On this page

Description:

This key represents an individual group object in the _inputs.*(object-input).options.groups array.

The value is an object that groups inputs together inside an Object Input without changing the data structure. Each group typically contains a heading and inputs array.

Appears in:
└── _inputs
    └── *
        └── Object Input
            └── options
                └── groups
                    └── [*]
Type:
Object
Properties:
collapsedboolean#

This key toggles whether this group is collapsed or expanded when first viewed.

Setting this key to true will collapse this group when first viewed.

Defaults to: false

Appears in: groups[*].

commentstring#

This key defines the subtext below the heading.

Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

Appears in: groups[*].

documentationObject#

This key defines the documentation link at the top of a Collection browser.

Collection documentation is useful for assisting your team members.

Appears in: collections_config.*, Text Input, Textarea Input, Code Input, Color Input, Boolean Input, Number Input, Range Input, Rich Text Input, URL Input, Select Input, Date/Datetime Input, Time Input, File Input, Multiselect Input, Choice Input, Multichoice Input, Object Input, groups[*], [*], options.entries, groups[*], Array Input.

Show examplesHide examples

In this example, the documentation link for the data Collection goes to CloudCannon Documentation.

Copied to clipboard
collections_config:
  data:
    documentation:
      url: https://cloudcannon.com/documentation/
      text: CloudCannon Documentation
      icon: star
{
  "collections_config": {
    "data": {
      "documentation": {
        "url": "https://cloudcannon.com/documentation/",
        "text": "CloudCannon Documentation",
        "icon": "star"
      }
    }
  }
}
headingstring#

This key defines the main text for the group shown when collapsed or expanded.

Appears in: groups[*].

inputsArray<inputs[*]>#

This key defines the keys of each input in this group.

Appears in: groups[*].

Examples:
Open in a new tab