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

Key Preview Entry

Table of contents

Description:

This key represents a key preview entry type for displaying data from a specific key on Cards in the Collection browser, Structures, and Snippets.

The value is an object that contains a key property with a string value. This displays the value of the specified data key in card previews.

Appears in:
└── Preview Entry
    └── Key Preview Entry
Type:
Object
Properties:
keystring Required#

This key defines the data key name to display in a key preview entry.

The value is a string that specifies the name of a data key whose value will be displayed on Cards in the Collection browser, Structures, and Snippets.

Show examplesHide examples

In this example, we have configured the key value to display the title field.

Copied to clipboard
collections_config:
  blog:
    preview:
      text:
        - key: title
{
  "collections_config": {
    "blog": {
      "preview": {
        "text": [
          {
            "key": "title"
          }
        ]
      }
    }
  }
}
Examples:

In this example, we have configured a key preview entry to display the title key.

Copied to clipboard
collections_config:
  blog:
    preview:
      text:
        - key: title
{
  "collections_config": {
    "blog": {
      "preview": {
        "text": [
          {
            "key": "title"
          }
        ]
      }
    }
  }
}
Open in a new tab