Working with a specific static site generator? Customize CloudCannon's documentation to suit your SSG.
Great! We'll show you documentation relevant to . You can change this any time using the dropdown in the navigation bar.
Object inputs represent object data within the Data Editor. They are ideal for grouping related inputs, or hiding complicated or infrequently edited data.
By default, they appear as a button that opens a new level in the editor to the side, showing the inputs inside the object. This continues as you click into nested object inputs. Each object level has a back button to return to the parent scope.
Alternatively, object inputs can be configured to behave differently:
Structured object, a switchable button that can be set from one or more values. Configured with the structures option.
Mutable object, a list showing each entry. Each entry is shown as its own input, including nested objects. Configured with the subtype option.
An object with entries shown in a list, with controls to add, remove, rename, and reorder.
Adding a new entry clones the value from the previous entry, and prompts you to enter the new key. At least one entry must exist to clone from, otherwise this input is invalid. This input prevents you removing the last entry.
Input configuration
copied
Input configuration
copied
Input configuration
copied
entries.allowed_keys can be used in combination with subtypes and entries.structures to control both the keys and the values for this object.
An object with entries shown in a list, with controls to add, remove, rename, and reorder.
Adding a new entry creates an empty time input, and prompts you to enter the new key. This object can have no entries, since the type is configured for the entries. Object subtypes are configured using the .* selector.
An object with entries shown in a list, with controls to add, remove, rename, and reorder.
The keys available when adding new entries and renaming existing entries are limited to the entries.allowed_keys list.
No entries can be added once all entries.allowed_keys are in use.
Entries with keys not included in entries.allowed_keys can exist, but if removed/renamed, cannot be re-added.
An object with entries shown in a list, with controls to add, remove, rename, and reorder.
When adding a new entry here, you are given the option of two predefined values: Image and External Link.
Input configuration
copied
Input configuration
copied
Input configuration
copied
entries.structures applies to the entries of an object, while structures applies to the object.
Mutable object with set keys and set values specific to keys#
An object with entries shown in a list, with controls to add, remove, rename, and reorder.
When adding a new entry here, you are given the option of two predefined values: Image and External Link.
The keys available when adding new entries and renaming existing entries are limited to the entries.allowed_keys list.
No entries can be added once all entries.allowed_keys are in use.
Entries with keys not included in entries.allowed_keys can exist, but if removed/renamed, cannot be re-added.
Changes how this is object input is displayed and interacted with. Defaults to object.
If set to object, data entries appear as standard inputs, nested one layer deeper.
If set to mutable, data entries within an object input can be added, renamed, removed and reordered. This also changes the appearance of the input, by listing entries as a sequential group with controls for adding, removing, renaming and reordering.
Defines a limited set of keys that can exist on the data within an object input. This set is used when entries are added and renamed with subtype: mutable. Defaults to [].
Has no effect if subtype anything but mutable. Only applies to mutable objects.
Provides data formats when adding entries to the data within this object input. When adding an entry, team members are prompted to choose from a number of values you have defined. Has no default.
Has no effect if subtype anything but mutable. Only applies to mutable objects.
If set as an object, the structures value is used directly.
If set as a string, the structures value is fetched from the configuration cascade. This allows you to define _structures elsewhere and reference it from here.
This looks similar to, and shares same format as structures. However, entries.structures applies to the entries within the object, and structures applies to the object itself.
Reduces the set of structure values available for entries with specific keys within a mutable object input. This set is used when entries are added with subtype: mutable. Structure values are referred to by their id.
Has no effect if subtype anything but mutable. Only applies to mutable objects.
Used to supply help text above the key input when adding/renaming within a mutable object input. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript and inline code elements are allowed.
Has no effect if subtype anything but mutable. Only applies to mutable objects.
Provides a custom link for documentation for editors shown above the key input when adding/renaming within a mutable object input. Contains the following fields:
url for the href value of the link (String, required).
text for the visible text used in the link (String). Defaults to Documentation.
icon for the icon displayed next to the link. Must be a Material Icon name. Defaults to auto_stories.
_inputs:my_object:type: object
options:subtype: mutable
entries:documentation:url:'https://example.com/documentation/'text: Read more about adding/renaming this key
Has no effect if subtype anything but mutable. Only applies to mutable objects.
Allows you to group the inputs inside this object together without changing the data structure.
Groups are labelled with a heading and description. They can start collapsed or expanded (default). The inputs that belong to each group are referred to by key. Groups can only contain inputs inside this object.
Ungrouped inputs are displayed after the groups by default, but you can reverse this with place_groups_below.
The preview definition for changing the way data within an object input is previewed before being expanded. The options available for object inputs are:
If the input has structures, the preview from the structure definition is used instead.
Object inputs now support the new preview option. Read our migration guide if you are still using the old options: text_key, subtext_key, image_key and icon.
Controls the image shown on the unopened input. Has no default, falls back to thumbnail_image, thumbnail_image_path, image, and image_path in that order.
Provides data formats for value of this object. When choosing an item, team members are prompted to choose from a number of values you have defined. Has no default.
If set as an object, the structures value is used directly.
If set as a string, the structures value is fetched from the configuration cascade. This allows you to define _structures elsewhere and reference it from here.
This looks similar to, and shares same format as entries.structures. However, structures applies to the object itself, and entries.structures applies to the entries within the object.