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

comment

Table of contents

Description:

This key defines the subtitle text above an Input.

CloudCannon supports a limited selection of Markdown formatting for the value of this key: links, bold, italic, subscript, superscript, and inline code.

This key has no default.

Appears in:
└── _inputs
    └── *
        ├── Text Input
        │   └── comment
        ├── Textarea Input
        │   └── comment
        ├── Code Input
        │   └── comment
        ├── Color Input
        │   └── comment
        ├── Boolean Input
        │   └── comment
        ├── Number Input
        │   └── comment
        ├── Range Input
        │   └── comment
        ├── Rich Text Input
        │   └── comment
        ├── Date/Datetime Input
        │   └── comment
        ├── Time Input
        │   └── comment
        ├── File Input
        │   └── comment
        ├── URL Input
        │   └── comment
        ├── Select Input
        │   └── comment
        ├── Multiselect Input
        │   └── comment
        ├── Choice Input
        │   └── comment
        ├── Multichoice Input
        │   └── comment
        ├── Object Input
        │   └── comment
        └── Array Input
            └── comment
Type:
string
Examples:

In this example, we want to add helpful guidance for our page_description Input.

Copied to clipboard
_inputs:
  page_description:
    type: text
    label: Page Description
    comment: Enter a brief description of this page for search engines
{
  "_inputs": {
    "page_description": {
      "type": "text",
      "label": "Page Description",
      "comment": "Enter a brief description of this page for search engines"
    }
  }
}
Open in a new tab