☁️ Loving our new documentation website? Provide feedback in the CloudCannon Community! ✨

Developer ReferenceConfiguration File

options

Table of contents

Description:

This key defines options that are specific to Object Inputs.

Appears in:
└── _inputs
    └── *
        └── Object Input
            └── options
Type:
Object
Properties:
allow_label_formattingboolean#

This key toggles whether labels on mutable object entries are formatted.

Setting this key to true will format labels on mutable object entries.

By default, this key is false (i.e., labels are not formatted).

Defaults to: false

empty_typestring#

This key defines how an 'empty' value will be saved. Does not apply to existing empty values.

Defaults to: null

Allowed values: null object

Show examplesHide examples

In this example, we have configured how empty object values will be saved.

Copied to clipboard
_inputs:
  metadata:
    type: object
    options:
      empty_type: object
{
  "_inputs": {
    "metadata": {
      "type": "object",
      "options": {
        "empty_type": "object"
      }
    }
  }
}
entriesObject#

This key defines the appearance and function of entries in a mutable Object Input.

The value is an object that can contain optional allowed_keys, structures, assigned_structures, comment, and documentation keys.

Available for Mutable Objects only.

Show examplesHide examples

In this example, we have configured entries options with assigned structures for specific allowed keys.

Copied to clipboard
_inputs:
  metadata:
    type: object
    options:
      allow_create: true
      entries:
        allowed_keys:
          - title
        assigned_structures:
          title:
            - article_metadata
            - page_metadata
{
  "_inputs": {
    "metadata": {
      "type": "object",
      "options": {
        "allow_create": true,
        "entries": {
          "allowed_keys": [
            "title"
          ],
          "assigned_structures": {
            "title": [
              "article_metadata",
              "page_metadata"
            ]
          }
        }
      }
    }
  }
}
groupsArray<groups[*]>#

This key defines how you can group the inputs inside this object together without changing the data structure.

place_groups_belowboolean#

This key defines which order input groups and ungrouped inputs appear in.

Defaults to: false

previewObject#

This key defines the appearance of a Card.

You can configure Card preview for Collections, Schemas, Object inputs, Array inputs, Select inputs, Structures, the Structure modal, Snippets, and the Snippet modal.

For more information about previews, please read our documentation on configuring card previews.

Show examplesHide examples

In this example, we have configured the appearance of file Cards in the Collection browser.

Copied to clipboard
collections_config:
  blog:
    preview:
      text:
        - key: title
      subtext:
        - key: author
      icon: edit_note
      icon_color:
        - key: color
        - '#ff0000'
      image:
        - key: image
      metadata:
        - template:
            - url
        - icon: event
          text:
            - template: Published on {date|date_long}
      gallery:
        - key: featured_image
{
  "collections_config": {
    "blog": {
      "preview": {
        "text": [
          {
            "key": "title"
          }
        ],
        "subtext": [
          {
            "key": "author"
          }
        ],
        "icon": "edit_note",
        "icon_color": [
          {
            "key": "color"
          },
          "#ff0000"
        ],
        "image": [
          {
            "key": "image"
          }
        ],
        "metadata": [
          {
            "template": [
              "url"
            ]
          },
          {
            "icon": "event",
            "text": [
              {
                "template": "Published on {date|date_long}"
              }
            ]
          }
        ],
        "gallery": [
          {
            "key": "featured_image"
          }
        ]
      }
    }
  }
}

In this example, we have configured the appearance of Cards in inputs using the Structure staff.

Copied to clipboard
_structures:
  staff:
    values:
      - value:
          _type: Employee
          name: 
          job_description: 
          profile_picture: 
        preview:
          text:
            - key: name
            - Employee
          subtext:
            - key: job_description
            - Description of position
          image:
            - key: profile_picture
          icon: support_agent
      - value:
          _type: Manager
          name: 
          job_description: 
          profile_picture: 
          url: 
        preview:
          text:
            - key: name
            - Manager
          subtext:
            - key: job_description
            - Description of position
          image:
            - key: profile_picture
          icon: face
{
  "_structures": {
    "staff": {
      "values": [
        {
          "value": {
            "_type": "Employee",
            "name": null,
            "job_description": null,
            "profile_picture": null
          },
          "preview": {
            "text": [
              {
                "key": "name"
              },
              "Employee"
            ],
            "subtext": [
              {
                "key": "job_description"
              },
              "Description of position"
            ],
            "image": [
              {
                "key": "profile_picture"
              }
            ],
            "icon": "support_agent"
          }
        },
        {
          "value": {
            "_type": "Manager",
            "name": null,
            "job_description": null,
            "profile_picture": null,
            "url": null
          },
          "preview": {
            "text": [
              {
                "key": "name"
              },
              "Manager"
            ],
            "subtext": [
              {
                "key": "job_description"
              },
              "Description of position"
            ],
            "image": [
              {
                "key": "profile_picture"
              }
            ],
            "icon": "face"
          }
        }
      ]
    }
  }
}
requiredboolean#

This key toggles whether CloudCannon requires this Input to have a value.

Setting this key to true will require you to enter a value to save your changes, or discard your unsaved changes.

By default, this key is false (i.e., CloudCannon does not require this Input to have a value).

This key is available for Array, Code, Color, Date and Time, File, Number, Object, Select and Multiselect, Text, Rich Text, and URL Inputs.

Defaults to: false

Show examplesHide examples

In this example, we want to require our team to enter an author value for markup files with this Input.

Copied to clipboard
_inputs:
  author:
    type: text
    comment: Enter the name of the author for this blog post.
    options:
      required: true
{
  "_inputs": {
    "author": {
      "type": "text",
      "comment": "Enter the name of the author for this blog post.",
      "options": {
        "required": true
      }
    }
  }
}
required_messagestring#

This key defines a custom error message that explains why a value has failed the validation criteria from options.required.

This key requires you to define options.required.

This key has no default.

This key is available for Array, Code, Color, Date and Time, File, Number, Object, Select and Multiselect, Text, Rich Text, and URL Inputs.

Show examplesHide examples

In this example, we prompt our team to use enter an Input value using a required message.

Copied to clipboard
_inputs:
  author:
    type: text
    comment: Enter the name of the author for this blog post.
    options:
      required: true
      required_message: You are not allowed to leave this blank.
{
  "_inputs": {
    "author": {
      "type": "text",
      "comment": "Enter the name of the author for this blog post.",
      "options": {
        "required": true,
        "required_message": "You are not allowed to leave this blank."
      }
    }
  }
}
structuresStructure Reference|Structure#

This key defines 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. structures applies to the object itself.

subtypestring#

This key defines the appearance and behavior of the input.

Allowed values: object mutable tabbed

viewstring#

This key defines how object previews are rendered.

Allowed values: card gallery gallery-left

Examples:
Open in a new tab