latest--cloudcannon-config.legacy-eleventy.schema

Type	object
Schema URL	https://catalog.lintel.tools/schemas/schemastore/cloudcannon-configuration/_shared/latest--cloudcannon-config.legacy-eleventy.schema.json
Parent schema	cloudcannon-configuration

paths:BuildCoupled object

Paths to where new asset files are uploaded to. They also set the default path when choosing existing images, and linking to existing files. Each path is relative to global source.

static string

uploads string

Default: "uploads"

uploads_filename string

dam_uploads string

dam_uploads_filename string

dam_static string

uploads_use_relative_path boolean

Default: false

collections string

Parent folder of all collections.

data string

Parent folder of all site data files.

layouts string

Parent folder of all site layout files. Only applies to Jekyll, Hugo, and Eleventy sites.

includes string

Parent folder of all includes, partials, or shortcode files. Only applies to Jekyll, Hugo, and Eleventy sites.

paths.static string

paths.uploads string

paths.uploads_filename string

paths.dam_uploads string

paths.dam_uploads_filename string

paths.dam_static string

paths.uploads_use_relative_path boolean

source string

collections_config:BuildCoupled Record<string, object>

Definitions for your collections, which are the sets of content files for your site grouped by folder. Entries are keyed by a chosen collection key, and contain configuration specific to that collection.

path string

This key defines the folder path for the collection key in which it is nested. The value for this key is relative to your Site source. Each Collection must have a unique path.

glob string[] | string

This key defines globs which filter the files visible in the Collection browser for a given Collection. Values in this array are relative to the Collection path.

icon string

Material Symbol icon names available in CloudCannon for UI elements and content previews.

type.documentation object

Configuration for documentation links displayed in the CloudCannon interface.

url string required

The "href" value of the link.

text string

The visible text used in the link.

icon

The icon displayed next to the link.

Default: "auto_stories"

All of: Icon string

EditorKey string

The available editors in CloudCannon: visual, content, and data editors.

type.create object

Controls where new files are saved.

path string

The raw template to be processed when creating files. Relative to the containing collection's path.

extra_data Record<string, string>

Adds to the available data placeholders coming from the file. Entry values follow the same format as path, and are processed sequentially before path. These values are not saved back to your file.

publish_to string

Defines a target collection when publishing. When a file is published, the target collection's create definition is used instead.

_inputs

All of: Inputs object

_inputs_from_glob

All of: type._inputs_from_glob string[]

_select_data

All of: Select Data object

_structures

All of: Structures object

_structures_from_glob

All of: type._structures_from_glob string[]

Controls the behavior and appearance of your inputs in all data editing interfaces.

TextInput object

Provides a simple editing interface for plain text.

type string required

Sets an input type, which controls how this input appears and behaves.

Values: "text" "email" "disabled" "pinterest" "facebook" "twitter" "github" "instagram"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Text Inputs.

23 nested properties

max_length number

This key defines the maximum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_length_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define options.max_length.

min_length number

This key defines the minimum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_length_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_length.

max_words number

This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_words_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.

min_words number

This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_words_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_words.

max_graphemes number

This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_graphemes_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.

min_graphemes number

This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_graphemes_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_graphemes.

locale string

This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have max_words, min_words, max_graphemes, or min_graphemes configured.

pattern string

This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.

pattern_message string

This key defines the message that explains which regular expression an Input will accept. This key requires you to define options.pattern.

pattern_flags object

This key defines the flags (e.g. case-insensitive searching) for the regular expression set in options.pattern.

6 nested properties

global boolean

g - Search globally.

Default: false

ignore_case boolean

i - Case-insensitive.

Default: false

multiline boolean

m - ^ and $ match the start and end of each line rather than the entire string.

Default: false

dot_all boolean

s - . matches newline characters.

Default: false

unicode boolean

u - Pattern is treated as a sequence of Unicode code points.

Default: false

unicode_sets boolean

v - Extended unicode mode.

Default: false

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(text) string

placeholder string

Text shown when this input has no value.

icon

Icon shown beside the input.

All of: Icon string

icon_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon_background_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

type._inputs.*.comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

type._inputs.*.context object

Adds an expandable section of rich text below the input.

content string

The rich text content shown when opened. Supports a limited set of Markdown.

open boolean

Makes the content visible initially.

Default: false

title string

The text shown when not open. Defaults to "Context" if unset.

icon

The icon shown when not open. Defaults to "auto_stories" if unset.

All of: Icon string

type._inputs.*.label string

Optionally changes the text above this input.

type._inputs.*.hidden boolean | string

Toggles the visibility of this input.

type._inputs.*.disabled boolean | string

Toggles if this input can be edited.

type._inputs.*.instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

type._inputs.*.disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

type._inputs.*.cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

type._inputs.*.options.max_length number

This key defines the maximum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

type._inputs.*.options.max_length_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define options.max_length.

type._inputs.*.options.min_length number

This key defines the minimum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

type._inputs.*.options.min_length_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_length.

type._inputs.*.options.max_words number

This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

type._inputs.*.options.max_words_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.

type._inputs.*.options.min_words number

This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

type._inputs.*.options.min_words_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_words.

type._inputs.*.options.max_graphemes number

This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

type._inputs.*.options.max_graphemes_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.

type._inputs.*.options.min_graphemes number

This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

type._inputs.*.options.min_graphemes_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_graphemes.

type._inputs.*.options.locale string

This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have max_words, min_words, max_graphemes, or min_graphemes configured.

type._inputs.*.options.pattern string

This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.

type._inputs.*.options.pattern_message string

This key defines the message that explains which regular expression an Input will accept. This key requires you to define options.pattern.

type._inputs.*.options.pattern_flags object

This key defines the flags (e.g. case-insensitive searching) for the regular expression set in options.pattern.

global boolean

g - Search globally.

Default: false

ignore_case boolean

i - Case-insensitive.

Default: false

multiline boolean

m - ^ and $ match the start and end of each line rather than the entire string.

Default: false

dot_all boolean

s - . matches newline characters.

Default: false

unicode boolean

u - Pattern is treated as a sequence of Unicode code points.

Default: false

unicode_sets boolean

v - Extended unicode mode.

Default: false

type._inputs.*.options.required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

type._inputs.*.options.required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

type._inputs.*.options.empty_type(text) string

Set how an ‘empty’ value will be saved. Does not apply to existing empty values.

PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

type.preview-entry.(array) type.preview-entry[]

type.preview-entry type.preview-entry.(key) | type.preview-entry.(template) | type.preview-entry.(text) | type.preview-entry.(raw-text) | type.preview-entry.(false)

type.preview-entry.(key) object

key string required

type.preview-entry.(template) object

template string required

type.preview-entry.(text) object

text string required

type.preview-entry.(raw-text) string

type.preview-entry.(false) boolean

TextareaInput object

Provides an editing interface for plain text.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "textarea"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Textarea Inputs.

21 nested properties

max_length number

This key defines the maximum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_length_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define options.max_length.

min_length number

This key defines the minimum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_length_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_length.

max_words number

This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_words_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.

min_words number

This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_words_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_words.

max_graphemes number

This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_graphemes_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.

min_graphemes number

This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_graphemes_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_graphemes.

locale string

This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have max_words, min_words, max_graphemes, or min_graphemes configured.

pattern string

This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.

pattern_message string

This key defines the message that explains which regular expression an Input will accept. This key requires you to define options.pattern.

pattern_flags object

This key defines the flags (e.g. case-insensitive searching) for the regular expression set in options.pattern.

6 nested properties

global boolean

g - Search globally.

Default: false

ignore_case boolean

i - Case-insensitive.

Default: false

multiline boolean

m - ^ and $ match the start and end of each line rather than the entire string.

Default: false

dot_all boolean

s - . matches newline characters.

Default: false

unicode boolean

u - Pattern is treated as a sequence of Unicode code points.

Default: false

unicode_sets boolean

v - Extended unicode mode.

Default: false

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(text) string

placeholder string

Text shown when this input has no value.

show_count boolean

Shows a character counter below the input if enabled.

Default: false

CodeInput object

Provides an editing interface for code or mono-spaced plain text content.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "code"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Code Inputs.

26 nested properties

tab_size number

Default: 2

theme

Default: "basic_dark"

All of: Theme string

show_gutter boolean

Default: true

soft_wrap boolean

Default: false

max_length number

This key defines the maximum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_length_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define options.max_length.

min_length number

This key defines the minimum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_length_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_length.

max_words number

This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_words_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.

min_words number

This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_words_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_words.

max_graphemes number

This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_graphemes_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.

min_graphemes number

This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_graphemes_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_graphemes.

locale string

This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have max_words, min_words, max_graphemes, or min_graphemes configured.

pattern string

This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.

pattern_message string

This key defines the message that explains which regular expression an Input will accept. This key requires you to define options.pattern.

pattern_flags object

This key defines the flags (e.g. case-insensitive searching) for the regular expression set in options.pattern.

6 nested properties

global boolean

g - Search globally.

Default: false

ignore_case boolean

i - Case-insensitive.

Default: false

multiline boolean

m - ^ and $ match the start and end of each line rather than the entire string.

Default: false

dot_all boolean

s - . matches newline characters.

Default: false

unicode boolean

u - Pattern is treated as a sequence of Unicode code points.

Default: false

unicode_sets boolean

v - Extended unicode mode.

Default: false

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(text) string

max_visible_lines number

Sets the maximum number of visible lines for this input, effectively controlling maximum height. When the containing text exceeds this number, the input becomes a scroll area.

min_visible_lines number

Sets the minimum number of visible lines for this input, effectively controlling initial height. When the containing text exceeds this number, the input grows line by line to the lines defined by max_visible_lines.

syntax

Changes how the editor parses your content for syntax highlighting. Should be set to the language of the code going into the input.

All of: Syntax string

Theme string

Syntax string

Available syntax highlighting languages for code editors in CloudCannon.

ColorInput object

Provides an editing interface for color values.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "color"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Color Inputs.

23 nested properties

max_length number

This key defines the maximum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_length_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define options.max_length.

min_length number

This key defines the minimum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_length_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_length.

max_words number

This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_words_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.

min_words number

This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_words_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_words.

max_graphemes number

This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_graphemes_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.

min_graphemes number

This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_graphemes_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_graphemes.

locale string

This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have max_words, min_words, max_graphemes, or min_graphemes configured.

pattern string

This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.

pattern_message string

This key defines the message that explains which regular expression an Input will accept. This key requires you to define options.pattern.

pattern_flags object

This key defines the flags (e.g. case-insensitive searching) for the regular expression set in options.pattern.

6 nested properties

global boolean

g - Search globally.

Default: false

ignore_case boolean

i - Case-insensitive.

Default: false

multiline boolean

m - ^ and $ match the start and end of each line rather than the entire string.

Default: false

dot_all boolean

s - . matches newline characters.

Default: false

unicode boolean

u - Pattern is treated as a sequence of Unicode code points.

Default: false

unicode_sets boolean

v - Extended unicode mode.

Default: false

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(text) string

format string

Sets what format the color value is saved as. Defaults to the naming convention, or HEX if that is unset.

Values: "rgb" "hex" "hsl" "hsv"

alpha boolean

Toggles showing a control for adjusting the transparency of the selected color. Defaults to using the naming convention, enabled if the input key ends with "a".

palette string[]

hide_picker boolean

Default: false

BooleanInput object

Provides an editing interface for true or false values.

type string required

Sets an input type, which controls how this input appears and behaves.

Values: "checkbox" "switch"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

NumberInput object

Provides an editing interface for numeric values.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "number"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Number Inputs.

8 nested properties

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(number) string

min

All of: type._inputs.*.options.min number

max

All of: type._inputs.*.options.max number

step number

A number that specifies the granularity that the value must adhere to, or the special value any, which allows any decimal value between max and min.

min_message string

This key defines the message that explains why an Input needs to have a minimum numerical value. This key requires you to define options.min.

max_message string

This key defines the message that explains why an Input needs to have a maximum numerical value. This key requires you to define options.max.

type._inputs.*.options.empty_type(number) string

Set how an ‘empty’ value will be saved. Does not apply to existing empty values.

type._inputs.*.options.min number

This key defines the minimum numerical value CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from entering a lesser numerical value. If the Input already contains a lesser numerical value, CloudCannon will require you to enter a valid value to save your changes, or discard your unsaved changes.

type._inputs.*.options.max number

This key defines the maximum numerical value CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from entering a greater numerical value. If the Input already contains a greater numerical value, CloudCannon will require you to enter a valid value to save your changes, or discard your unsaved changes.

type._inputs.*.options.step number

A number that specifies the granularity that the value must adhere to, or the special value any, which allows any decimal value between max and min.

type._inputs.*.options.min_message string

This key defines the message that explains why an Input needs to have a minimum numerical value. This key requires you to define options.min.

type._inputs.*.options.max_message string

This key defines the message that explains why an Input needs to have a maximum numerical value. This key requires you to define options.max.

RangeInput object

Provides a slider interface for selecting a numeric value.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "range"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Range Inputs.

8 nested properties

min number required

This key defines the minimum numerical value CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from entering a lesser numerical value. If the Input already contains a lesser numerical value, CloudCannon will require you to enter a valid value to save your changes, or discard your unsaved changes.

max number required

This key defines the maximum numerical value CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from entering a greater numerical value. If the Input already contains a greater numerical value, CloudCannon will require you to enter a valid value to save your changes, or discard your unsaved changes.

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(number) string

step number

A number that specifies the granularity that the value must adhere to, or the special value any, which allows any decimal value between max and min.

min_message string

This key defines the message that explains why an Input needs to have a minimum numerical value. This key requires you to define options.min.

max_message string

This key defines the message that explains why an Input needs to have a maximum numerical value. This key requires you to define options.max.

RichTextInput object

Provides an editing interface for HTML markup content.

type string required

Sets an input type, which controls how this input appears and behaves.

Values: "html" "markdown"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Rich Text Inputs.

66 nested properties

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

paths

All of: Paths object

bold boolean

Enables a control to set selected text to bold.

Default: true

copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

Default: false

italic boolean

Enables a control to italicize selected text.

Default: true

link boolean

Enables a control to create hyperlinks around selected text.

Default: true

redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

Default: true

strike boolean

Enables a control to strike selected text.

Default: false

subscript boolean

Enables a control to set selected text to subscript.

Default: false

superscript boolean

Enables a control to set selected text to superscript.

Default: false

underline boolean

Enables a control to underline selected text.

Default: false

undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

blockquote boolean

Enables a control to wrap blocks of text in block quotes.

Default: true

bulletedlist boolean

Enables a control to insert an unordered list, or to convert selected blocks of text into a unordered list.

Default: true

center string

Enables a control to center align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

code_inline boolean

Enables a control to create an inline code element, containing any selected text.

Default: false

code_block boolean

Enables a control to insert a code block.

Default: false

code boolean

Enables both block and inline code controls: code_block and code_inline.

Default: false

embed boolean

Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.

Default: false

format string

Enables a drop down menu for structured text. Has options for "p", "h1", "h2", "h3", "h4", "h5", "h6". Set as space separated options (e.g. "p h1 h2").

Default: "p h1 h2 h3 h4 h5 h6"

horizontalrule boolean

Enables a control to insert a horizontal rule.

Default: false

image boolean

Enables a control to insert an image. The image can be uploaded, existing or an external link.

Default: true

indent boolean

Enables a control to increase indentation for numbered and unordered lists.

Default: false

justify string

Enables a control to justify text by toggling a class name for a block of text. The value is the class name the editor should add to justify the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

left string

Enables a control to left align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

numberedlist boolean

Enables a control to insert a numbered list, or to convert selected blocks of text into a numbered list.

Default: true

outdent boolean

Enables a control to reduce indentation for numbered and unordered lists.

Default: false

right string

Enables a control to right align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

snippet boolean

Enables a control to insert snippets, if any are available.

Default: true

styles string

Enables a drop down menu for editors to style selected text or blocks or text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) to the CSS file containing the styles.

table boolean

Enables a control to insert a table. Further options for table cells are available in the context menu for cells within the editor.

Default: false

join_above boolean

Enables a control to join the selected block with the block above it.

Default: false

join_below boolean

Enables a control to join the selected block with the block below it.

Default: false

max_length number

This key defines the maximum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_length_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define options.max_length.

min_length number

This key defines the minimum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_length_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_length.

max_words number

This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_words_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.

min_words number

This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_words_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_words.

max_graphemes number

This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_graphemes_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.

min_graphemes number

This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_graphemes_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_graphemes.

locale string

This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have max_words, min_words, max_graphemes, or min_graphemes configured.

pattern string

This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.

pattern_message string

This key defines the message that explains which regular expression an Input will accept. This key requires you to define options.pattern.

pattern_flags object

This key defines the flags (e.g. case-insensitive searching) for the regular expression set in options.pattern.

6 nested properties

global boolean

g - Search globally.

Default: false

ignore_case boolean

i - Case-insensitive.

Default: false

multiline boolean

m - ^ and $ match the start and end of each line rather than the entire string.

Default: false

dot_all boolean

s - . matches newline characters.

Default: false

unicode boolean

u - Pattern is treated as a sequence of Unicode code points.

Default: false

unicode_sets boolean

v - Extended unicode mode.

Default: false

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(text) string

allow_resize boolean

prevent_resize boolean

Hides the resize handler to vertically resize the input.

Default: false

initial_height number

Defines the initial height of this input in pixels (px).

type._inputs.*.options.mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

type._inputs.*.options.resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

type._inputs.*.options.width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

type._inputs.*.options.height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

type._inputs.*.options.expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

type._inputs.*.options.image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

type._inputs.*.options.allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

type._inputs.*.options.prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

type._inputs.*.options.sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

type.paths object

static string

uploads string

Default: "uploads"

uploads_filename string

dam_uploads string

dam_uploads_filename string

dam_static string

uploads_use_relative_path boolean

Default: false

type._editables.*.bold boolean

Enables a control to set selected text to bold.

type._editables.*.copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

type._editables.*.italic boolean

Enables a control to italicize selected text.

type._editables.*.link boolean

Enables a control to create hyperlinks around selected text.

type._editables.*.redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

type._editables.*.removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

type._editables.*.strike boolean

Enables a control to strike selected text.

type._editables.*.subscript boolean

Enables a control to set selected text to subscript.

type._editables.*.superscript boolean

Enables a control to set selected text to superscript.

type._editables.*.underline boolean

Enables a control to underline selected text.

type._editables.*.undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

type._editables.*.remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

type._editables.*.allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

type._editables.*.blockquote boolean

Enables a control to wrap blocks of text in block quotes.

type._editables.*.bulletedlist boolean

Enables a control to insert an unordered list, or to convert selected blocks of text into a unordered list.

type._editables.*.center string

Enables a control to center align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

type._editables.*.code_inline boolean

Enables a control to create an inline code element, containing any selected text.

type._editables.*.code_block boolean

Enables a control to insert a code block.

type._editables.*.code boolean

Enables both block and inline code controls: code_block and code_inline.

type._editables.*.embed boolean

Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.

type._editables.*.format string

Enables a drop down menu for structured text. Has options for "p", "h1", "h2", "h3", "h4", "h5", "h6". Set as space separated options (e.g. "p h1 h2").

type._editables.*.horizontalrule boolean

Enables a control to insert a horizontal rule.

type._editables.*.image boolean

Enables a control to insert an image. The image can be uploaded, existing or an external link.

type._editables.*.indent boolean

Enables a control to increase indentation for numbered and unordered lists.

type._editables.*.justify string

Enables a control to justify text by toggling a class name for a block of text. The value is the class name the editor should add to justify the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

type._editables.*.left string

Enables a control to left align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

type._editables.*.numberedlist boolean

Enables a control to insert a numbered list, or to convert selected blocks of text into a numbered list.

type._editables.*.outdent boolean

Enables a control to reduce indentation for numbered and unordered lists.

type._editables.*.right string

Enables a control to right align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

type._editables.*.snippet boolean

Enables a control to insert snippets, if any are available.

type._editables.*.styles string

Enables a drop down menu for editors to style selected text or blocks or text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) to the CSS file containing the styles.

type._editables.*.table boolean

Enables a control to insert a table. Further options for table cells are available in the context menu for cells within the editor.

type._editables.*.join_above boolean

Enables a control to join the selected block with the block above it.

type._editables.*.join_below boolean

Enables a control to join the selected block with the block below it.

DateInput object

Provides an editing interface for date and/or time values.

type string required

Sets an input type, which controls how this input appears and behaves.

Values: "date" "datetime"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Date Inputs.

8 nested properties

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(text) string

timezone

Specifies the time zone that dates are displayed and edited in. Also changes the suffix the date is persisted to the file with. Defaults to the global timezone.

All of: Timezone string

start_from string

This key defines the earliest date and time, inclusive, that CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from selecting an earlier date and time. If the Input already contains an earlier date and time, CloudCannon will require you to change it to a valid value to save your changes, or discard your unsaved changes. Value must be in ISO8601 format. If options.end_before is also configured, this key cannot be a later date and time.

start_from_message string

This key defines the message that explains why an Input needs to have a start date. This key requires you to define options.start_from.

end_before string

This key defines the date and time, exclusive, that CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from selecting a later date and time. If the Input already contains a later date and time, CloudCannon will require you to change it to a valid value to save your changes, or discard your unsaved changes. Value must be in ISO8601 format. If options.start_from is also configured, this key cannot be an earlier date and time. This key has no default.

end_before_message string

This key defines the message that explains why an Input needs to have an end date. This key requires you to define options.end_before. This key has no default.

type.timezone string

TimeInput object

Provides an editing interface for time values only.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "time"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Time Inputs.

3 nested properties

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(text) string

FileInput object

Provides an editing interface for uploading files to your repository or DAM and browsing existing assets.

type string required

Sets an input type, which controls how this input appears and behaves.

Values: "file" "document" "image"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to File Inputs.

35 nested properties

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

max_length number

This key defines the maximum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_length_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define options.max_length.

min_length number

This key defines the minimum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_length_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_length.

max_words number

This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_words_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.

min_words number

This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_words_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_words.

max_graphemes number

This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_graphemes_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.

min_graphemes number

This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_graphemes_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_graphemes.

locale string

This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have max_words, min_words, max_graphemes, or min_graphemes configured.

pattern string

This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.

pattern_message string

This key defines the message that explains which regular expression an Input will accept. This key requires you to define options.pattern.

pattern_flags object

This key defines the flags (e.g. case-insensitive searching) for the regular expression set in options.pattern.

6 nested properties

global boolean

g - Search globally.

Default: false

ignore_case boolean

i - Case-insensitive.

Default: false

multiline boolean

m - ^ and $ match the start and end of each line rather than the entire string.

Default: false

dot_all boolean

s - . matches newline characters.

Default: false

unicode boolean

u - Pattern is treated as a sequence of Unicode code points.

Default: false

unicode_sets boolean

v - Extended unicode mode.

Default: false

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(text) string

paths

All of: Paths object

accepts_mime_types string | MimeType[]

Restricts which file types are available to select or upload to this input. Accepted format is an array or comma-separated string of MIME types. The special value "*" means any type is accepted.

max_file_size number

This key defines the maximum file size, in kilobytes, that CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from uploading a file larger than the specified size. If the Input already contains a file larger than the specified size, CloudCannon will require you to change it to a valid value to save your changes, or discard your unsaved changes. Value can be any positive integer.

max_file_size_message string

This key defines the message that explains why an Input needs to have a maximum file size. This key requires you to define options.max_file_size. This key has no default.

disable_upload_file boolean

Disables the context menu option and the drop area for uploading files.

Default: false

disable_direct_input boolean

Prevents typing into the text input, while still allowing context menu options to change the value.

Default: false

disable_upload_file_in_file_browser boolean

Prevents file uploads inside the "Select existing file/image" file browser modal window.

Default: false

type._inputs.*.options.accepts_mime_types string | MimeType[]

Restricts which file types are available to select or upload to this input. Accepted format is an array or comma-separated string of MIME types. The special value "*" means any type is accepted.

MimeType string

MIME type identifiers for file type validation and handling in CloudCannon.

type._inputs.*.options.max_file_size number

This key defines the maximum file size, in kilobytes, that CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from uploading a file larger than the specified size. If the Input already contains a file larger than the specified size, CloudCannon will require you to change it to a valid value to save your changes, or discard your unsaved changes. Value can be any positive integer.

type._inputs.*.options.max_file_size_message string

This key defines the message that explains why an Input needs to have a maximum file size. This key requires you to define options.max_file_size. This key has no default.

type._inputs.*.options.disable_upload_file boolean

Disables the context menu option and the drop area for uploading files.

type._inputs.*.options.disable_direct_input boolean

Prevents typing into the text input, while still allowing context menu options to change the value.

type._inputs.*.options.disable_upload_file_in_file_browser boolean

Prevents file uploads inside the "Select existing file/image" file browser modal window.

UrlInput object

Provides an editing interface for relative, absolute, and fully qualified URLs.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "url"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to URL Inputs.

39 nested properties

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

max_length number

This key defines the maximum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_length_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define options.max_length.

min_length number

This key defines the minimum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_length_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_length.

max_words number

This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_words_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.

min_words number

This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_words_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_words.

max_graphemes number

This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_graphemes_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.

min_graphemes number

This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_graphemes_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_graphemes.

locale string

This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have max_words, min_words, max_graphemes, or min_graphemes configured.

pattern string

This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.

pattern_message string

This key defines the message that explains which regular expression an Input will accept. This key requires you to define options.pattern.

pattern_flags object

This key defines the flags (e.g. case-insensitive searching) for the regular expression set in options.pattern.

6 nested properties

global boolean

g - Search globally.

Default: false

ignore_case boolean

i - Case-insensitive.

Default: false

multiline boolean

m - ^ and $ match the start and end of each line rather than the entire string.

Default: false

dot_all boolean

s - . matches newline characters.

Default: false

unicode boolean

u - Pattern is treated as a sequence of Unicode code points.

Default: false

unicode_sets boolean

v - Extended unicode mode.

Default: false

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(text) string

paths

All of: Paths object

accepts_mime_types string | MimeType[]

Restricts which file types are available to select or upload to this input. Accepted format is an array or comma-separated string of MIME types. The special value "*" means any type is accepted.

max_file_size number

This key defines the maximum file size, in kilobytes, that CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from uploading a file larger than the specified size. If the Input already contains a file larger than the specified size, CloudCannon will require you to change it to a valid value to save your changes, or discard your unsaved changes. Value can be any positive integer.

max_file_size_message string

This key defines the message that explains why an Input needs to have a maximum file size. This key requires you to define options.max_file_size. This key has no default.

disable_upload_file boolean

Disables the context menu option and the drop area for uploading files.

Default: false

disable_direct_input boolean

Prevents typing into the text input, while still allowing context menu options to change the value.

Default: false

disable_upload_file_in_file_browser boolean

Prevents file uploads inside the "Select existing file/image" file browser modal window.

Default: false

hide_link_to_file boolean

Hides the options to link to an existing file, and upload a new file. This does not prevent typing a file path in the input.

Default: false

hide_link_to_page boolean

Hides the option to link to a page. This does not prevent typing a file's output URL in the input.

Default: false

hide_link_to_email_address boolean

Hides the option to link to an email address. This does not prevent typing a mailto: link in the input.

Default: false

hide_link_to_telephone boolean

Hides the option to link to a telephone number. This does not prevent typing a tel: link in the input.

Default: false

SelectInput object

Provides an editing interface for data with multiple predefined options. Select inputs only allow one value.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "select"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Select Inputs.

27 nested properties

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

preview

All of: Preview object

picker_preview

All of: Picker Preview

allow_create boolean

Allows new text values to be created at edit time.

Default: false

allow_empty boolean

Provides an empty option alongside the options provided by values.

values string | string[] | object | object[] | object

Defines the values available to choose from. Optional, defaults to fetching values from the naming convention (e.g. colors or my_colors for data set colors).

value_key string

Defines the key used for mapping between saved values and objects in values. This changes how the input saves selected values to match. Defaults to checking for "id", "uuid", "path", "title", then "name". Has no effect unless values is an array of objects, the key is used instead for objects, and the value itself is used for primitive types.

view string

Controls how selected items are rendered.

Values: "card" "text" "gallery" "gallery-left"

picker_view string

Controls how selectable options are rendered.

Values: "card" "text" "gallery" "gallery-left"

max_length number

This key defines the maximum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_length_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define options.max_length.

min_length number

This key defines the minimum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_length_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_length.

max_words number

This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_words_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.

min_words number

This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_words_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_words.

max_graphemes number

This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_graphemes_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.

min_graphemes number

This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_graphemes_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_graphemes.

locale string

This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have max_words, min_words, max_graphemes, or min_graphemes configured.

pattern string

This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.

pattern_message string

This key defines the message that explains which regular expression an Input will accept. This key requires you to define options.pattern.

pattern_flags object

This key defines the flags (e.g. case-insensitive searching) for the regular expression set in options.pattern.

6 nested properties

global boolean

g - Search globally.

Default: false

ignore_case boolean

i - Case-insensitive.

Default: false

multiline boolean

m - ^ and $ match the start and end of each line rather than the entire string.

Default: false

dot_all boolean

s - . matches newline characters.

Default: false

unicode boolean

u - Pattern is treated as a sequence of Unicode code points.

Default: false

unicode_sets boolean

v - Extended unicode mode.

Default: false

empty_type

All of: type._inputs.*.options.empty_type(text) string

type.preview object

text

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

subtext

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

image

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon_background_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

tags string[]

metadata PreviewMetadataEntry[]

gallery object

7 nested properties

text

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

image

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon_background_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

fit string

Default: "padded"

Values: "padded" "cover" "contain" "cover-top"

background_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

type.preview.text

type.preview.subtext

type.preview.image

type.preview.icon

type.preview.icon_color

type.preview.icon_background_color

type.preview.tags string[]

type.preview.metadata PreviewMetadataEntry[]

PreviewMetadataEntry object

text

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

image

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon_background_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

type.preview.gallery object

text

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

image

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

icon_background_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

fit string

Default: "padded"

Values: "padded" "cover" "contain" "cover-top"

background_color

All of: PreviewEntries type.preview-entry.(array) | type.preview-entry.(raw-text) | type.preview-entry.(false)

preview.gallery.fit string

type.preview.gallery.background_color

type.picker_preview

type._inputs.*.options.allow_create boolean

Allows new text values to be created at edit time.

type._inputs.*.options.allow_empty boolean

Provides an empty option alongside the options provided by values.

type._inputs.*.options.values string | string[] | object | object[] | object

Defines the values available to choose from. Optional, defaults to fetching values from the naming convention (e.g. colors or my_colors for data set colors).

type._inputs.*.options.value_key string

Defines the key used for mapping between saved values and objects in values. This changes how the input saves selected values to match. Defaults to checking for "id", "uuid", "path", "title", then "name". Has no effect unless values is an array of objects, the key is used instead for objects, and the value itself is used for primitive types.

type._inputs.*.options.view string

Controls how selected items are rendered.

type._inputs.*.options.picker_view string

Controls how selectable options are rendered.

MultiselectInput object

Provides an editing interface for data with multiple predefined options. Multiselect inputs allow several values.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "multiselect"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Multiselect Inputs.

17 nested properties

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

preview

All of: Preview object

picker_preview

All of: Picker Preview

allow_create boolean

Allows new text values to be created at edit time.

Default: false

allow_empty boolean

Provides an empty option alongside the options provided by values.

values string | string[] | object | object[] | object

Defines the values available to choose from. Optional, defaults to fetching values from the naming convention (e.g. colors or my_colors for data set colors).

value_key string

Defines the key used for mapping between saved values and objects in values. This changes how the input saves selected values to match. Defaults to checking for "id", "uuid", "path", "title", then "name". Has no effect unless values is an array of objects, the key is used instead for objects, and the value itself is used for primitive types.

view string

Controls how selected items are rendered.

Values: "card" "text" "gallery" "gallery-left"

picker_view string

Controls how selectable options are rendered.

Values: "card" "text" "gallery" "gallery-left"

max_items number

This key defines the maximum number of items CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from adding more items to this Input. If the Input already contains more items, CloudCannon will require you to remove items until the Input contains a valid number to save your changes, or discard your unsaved changes.

max_items_message string

This key defines the message that explains why an Input needs to have a maximum number of items. This key requires you to define options.max_items.

min_items number

This key defines the minimum number of items CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from removing items from this Input below this value. If the Input already contains fewer items, CloudCannon will require you to add items until the Input contains a valid number to save your changes, or discard your unsaved changes.

min_items_message string

This key defines the message that explains why an Input needs to have a minimum number of items. This key requires you to define options.min_items.

unique_on string

This key defines the JSON Path selector that CloudCannon should use to determine if the value of an Input is unique. When configured, CloudCannon will require the value of the Input to be unique compared to the value defined on the JSON Path. If the Input already contains a non-unique value, CloudCannon will require you to change it to a valid value to save your changes, or discard your unsaved changes.

unique_on_message string

This key defines the message that explains why an Input needs to be unique. This key requires you to define options.unique_on.

empty_type

All of: type._inputs.*.options.empty_type(array) string

type._inputs.*.options.max_items number

This key defines the maximum number of items CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from adding more items to this Input. If the Input already contains more items, CloudCannon will require you to remove items until the Input contains a valid number to save your changes, or discard your unsaved changes.

type._inputs.*.options.max_items_message string

This key defines the message that explains why an Input needs to have a maximum number of items. This key requires you to define options.max_items.

type._inputs.*.options.min_items number

This key defines the minimum number of items CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from removing items from this Input below this value. If the Input already contains fewer items, CloudCannon will require you to add items until the Input contains a valid number to save your changes, or discard your unsaved changes.

type._inputs.*.options.min_items_message string

This key defines the message that explains why an Input needs to have a minimum number of items. This key requires you to define options.min_items.

type._inputs.*.options.unique_on string

This key defines the JSON Path selector that CloudCannon should use to determine if the value of an Input is unique. When configured, CloudCannon will require the value of the Input to be unique compared to the value defined on the JSON Path. If the Input already contains a non-unique value, CloudCannon will require you to change it to a valid value to save your changes, or discard your unsaved changes.

type._inputs.*.options.unique_on_message string

This key defines the message that explains why an Input needs to be unique. This key requires you to define options.unique_on.

type._inputs.*.options.empty_type(array) string

Set how an ‘empty’ value will be saved. Does not apply to existing empty values.

ChoiceInput object

Provides an editing interface for data with multiple predefined options. Choice inputs only allow one value.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "choice"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Choice Inputs.

26 nested properties

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

preview

All of: Preview object

picker_preview

All of: Picker Preview

allow_empty boolean

Provides an empty option alongside the options provided by values.

values string | string[] | object | object[] | object

Defines the values available to choose from. Optional, defaults to fetching values from the naming convention (e.g. colors or my_colors for data set colors).

value_key string

Defines the key used for mapping between saved values and objects in values. This changes how the input saves selected values to match. Defaults to checking for "id", "uuid", "path", "title", then "name". Has no effect unless values is an array of objects, the key is used instead for objects, and the value itself is used for primitive types.

view string

Controls how selected items are rendered.

Values: "card" "text" "gallery" "gallery-left"

picker_view string

Controls how selectable options are rendered.

Values: "card" "text" "gallery" "gallery-left"

max_length number

This key defines the maximum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_length_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define options.max_length.

min_length number

This key defines the minimum string length, in characters, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_length_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_length.

max_words number

This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_words_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.

min_words number

This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_words_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_words.

max_graphemes number

This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

max_graphemes_message string

This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.

min_graphemes number

This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.

min_graphemes_message string

This key defines the message that explains which minimum string length an Input will accept. This key requires you to define options.min_graphemes.

locale string

This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have max_words, min_words, max_graphemes, or min_graphemes configured.

pattern string

This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.

pattern_message string

This key defines the message that explains which regular expression an Input will accept. This key requires you to define options.pattern.

pattern_flags object

This key defines the flags (e.g. case-insensitive searching) for the regular expression set in options.pattern.

6 nested properties

global boolean

g - Search globally.

Default: false

ignore_case boolean

i - Case-insensitive.

Default: false

multiline boolean

m - ^ and $ match the start and end of each line rather than the entire string.

Default: false

dot_all boolean

s - . matches newline characters.

Default: false

unicode boolean

u - Pattern is treated as a sequence of Unicode code points.

Default: false

unicode_sets boolean

v - Extended unicode mode.

Default: false

empty_type

All of: type._inputs.*.options.empty_type(text) string

MultichoiceInput object

Provides an editing interface for data with multiple predefined options. Multichoice inputs allow several values.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "multichoice"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Multichoice Inputs.

16 nested properties

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

preview

All of: Preview object

picker_preview

All of: Picker Preview

allow_empty boolean

Provides an empty option alongside the options provided by values.

values string | string[] | object | object[] | object

Defines the values available to choose from. Optional, defaults to fetching values from the naming convention (e.g. colors or my_colors for data set colors).

value_key string

Defines the key used for mapping between saved values and objects in values. This changes how the input saves selected values to match. Defaults to checking for "id", "uuid", "path", "title", then "name". Has no effect unless values is an array of objects, the key is used instead for objects, and the value itself is used for primitive types.

view string

Controls how selected items are rendered.

Values: "card" "text" "gallery" "gallery-left"

picker_view string

Controls how selectable options are rendered.

Values: "card" "text" "gallery" "gallery-left"

max_items number

This key defines the maximum number of items CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from adding more items to this Input. If the Input already contains more items, CloudCannon will require you to remove items until the Input contains a valid number to save your changes, or discard your unsaved changes.

max_items_message string

This key defines the message that explains why an Input needs to have a maximum number of items. This key requires you to define options.max_items.

min_items number

This key defines the minimum number of items CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from removing items from this Input below this value. If the Input already contains fewer items, CloudCannon will require you to add items until the Input contains a valid number to save your changes, or discard your unsaved changes.

min_items_message string

This key defines the message that explains why an Input needs to have a minimum number of items. This key requires you to define options.min_items.

unique_on string

This key defines the JSON Path selector that CloudCannon should use to determine if the value of an Input is unique. When configured, CloudCannon will require the value of the Input to be unique compared to the value defined on the JSON Path. If the Input already contains a non-unique value, CloudCannon will require you to change it to a valid value to save your changes, or discard your unsaved changes.

unique_on_message string

This key defines the message that explains why an Input needs to be unique. This key requires you to define options.unique_on.

empty_type

All of: type._inputs.*.options.empty_type(array) string

ObjectInput object

Provides a user interface for a group of inputs.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "object"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Object Inputs.

11 nested properties

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

empty_type

All of: type._inputs.*.options.empty_type(object) string

preview

All of: Preview object

subtype string

Changes the appearance and behavior of the input.

Values: "object" "mutable" "tabbed"

entries object

Contains options for the "mutable" subtype.

5 nested properties

allowed_keys string[]

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 allow_create enabled. Has no effect if allow_create is not enabled.

assigned_structures Record<string, string[]>

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 effect if allow_create is false. entries.structures applies to the entries within the object.

structures type.structure-reference | type.structure

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

comment string

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.

documentation

Provides a custom link for documentation for editors shown above the key input when adding/renaming within a mutable object input.

All of: Documentation object

groups object[]

Allows you to group the inputs inside this object together without changing the data structure.

place_groups_below boolean

Controls which order input groups and ungrouped inputs appear in.

Default: false

allow_label_formatting boolean

Controls whether or not labels on mutable object entries are formatted.

Default: false

view string

Controls how object previews are rendered.

Values: "card" "gallery" "gallery-left"

structures type.structure-reference | type.structure

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

type._inputs.*.options.empty_type(object) string

Set how an ‘empty’ value will be saved. Does not apply to existing empty values.

type.structure-reference string

A reference to an existing structure.

type.structure object

Provides data formats when adding new items to arrays and objects, with options for how editors choose from available values.

values type.structure.values.%5B*%5D[] required

Defines what values are available to add when using this structure.

reorder_inputs boolean

If true, inputs are sorted to match when editing. Extra inputs are ordered after expected inputs, unless remove_extra_inputs is true. Defaults to true.

Default: true

hide_extra_inputs boolean

Hides unexpected inputs when editing. Has no effect if remove_extra_inputs is true. Defaults to false.

Default: false

remove_empty_inputs boolean

If checked, empty inputs are removed from the source file on save. Removed inputs will be available for editing again, provided they are in the matching schema/structure. Defaults to false.

Default: false

remove_extra_inputs boolean

If checked, extra inputs are removed when editing. Defaults to true.

Default: true

values_from_glob string[]

id_key string

Defines what key should be used to detect which structure an item is. If this key is not found in the existing structure, a comparison of key names is used. Defaults to "_type".

Default: "_type"

style string

Defines whether options are shown to your editors in a select menu (select, default) or a modal pop up window (modal) when adding a new item.

Default: "select"

Values: "select" "modal"

type.structure.values.[*] object

A single value option within a structure, defining the data format and appearance for content editors.

value required

The actual value used when items are added after selection.

reorder_inputs boolean

If true, inputs are sorted to match when editing. Extra inputs are ordered after expected inputs, unless remove_extra_inputs is true. Defaults to true.

Default: true

hide_extra_inputs boolean

Hides unexpected inputs when editing. Has no effect if remove_extra_inputs is true. Defaults to false.

Default: false

remove_empty_inputs boolean

If checked, empty inputs are removed from the source file on save. Removed inputs will be available for editing again, provided they are in the matching schema/structure. Defaults to false.

Default: false

remove_extra_inputs boolean

If checked, extra inputs are removed when editing. Defaults to true.

Default: true

preview

All of: Preview object

picker_preview

All of: Picker Preview

_inputs

All of: Inputs object

_inputs_from_glob

All of: type._inputs_from_glob string[]

_select_data

All of: Select Data object

_structures

All of: Structures object

_structures_from_glob

All of: type._structures_from_glob string[]

id string

A unique reference value used when referring to this structure value from the Object input's assigned_structures option.

default boolean

If set to true, this item will be considered the default type for this structure. If the type of a value within a structure cannot be inferred based on its id_key or matching fields, then it will fall back to this item. If multiple items have default set to true, only the first item will be used.

Default: false

icon

An icon used when displaying the structure (defaults to either format_list_bulleted for items in arrays, or notes otherwise).

All of: Icon string

image string

Path to an image in your source files used when displaying the structure. Can be either a source (has priority) or output path.

label string

Used as the main text in the interface for this value.

tags string[]

Used to group and filter items when selecting from a modal.

groups object[]

Allows you to group the inputs inside this object together without changing the data structure.

place_groups_below boolean

Controls which order input groups and ungrouped inputs appear in.

Default: false

tabbed boolean

Show nested objects as tabs. Requires all top-level keys to be objects.

Default: false

description string

Provides short descriptive text for editors shown in the Data Editor for expanded values matching this Structure value. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

documentation

Provides a custom link for documentation for editors shown in the Data Editor for expanded values matching this Structure value. Has no default.

All of: Documentation object

type._inputs_from_glob string[]

type._select_data Record<string, string[] | object | object[] | object>

Fixed datasets that can be referenced by the Values configuration for Select and Multiselect inputs.

type._structures Record<string, object>

Structured values for editors adding new items to arrays and objects. Entries here can be referenced in the configuration for array or object inputs.

type._structures_from_glob string[]

entries_comment string

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.

ArrayInput object

Provides a user interface for lists of inputs or input groups.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "array"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options object

Options that are specific to Array Inputs.

13 nested properties

required boolean

This key toggles whether CloudCannon requires this Input to have a value. If set to true, CloudCannon will require you to enter a value to save your changes, or discard your unsaved changes.

Default: false

required_message string

This key defines the message that explains why an Input is required. This key requires you to define options.required.

max_items number

This key defines the maximum number of items CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from adding more items to this Input. If the Input already contains more items, CloudCannon will require you to remove items until the Input contains a valid number to save your changes, or discard your unsaved changes.

max_items_message string

This key defines the message that explains why an Input needs to have a maximum number of items. This key requires you to define options.max_items.

min_items number

This key defines the minimum number of items CloudCannon will allow in an Input. When configured, CloudCannon will prevent you from removing items from this Input below this value. If the Input already contains fewer items, CloudCannon will require you to add items until the Input contains a valid number to save your changes, or discard your unsaved changes.

min_items_message string

This key defines the message that explains why an Input needs to have a minimum number of items. This key requires you to define options.min_items.

unique_on string

This key defines the JSON Path selector that CloudCannon should use to determine if the value of an Input is unique. When configured, CloudCannon will require the value of the Input to be unique compared to the value defined on the JSON Path. If the Input already contains a non-unique value, CloudCannon will require you to change it to a valid value to save your changes, or discard your unsaved changes.

unique_on_message string

This key defines the message that explains why an Input needs to be unique. This key requires you to define options.unique_on.

disable_add boolean

Hides the add button, and context menu actions on each item for adding new items to this Input.

Default: false

disable_remove boolean

Hides the context menu actions on each item for removing them.

Default: false

disable_reorder boolean

Hides the controls on each item for moving them.

Default: false

empty_type

All of: type._inputs.*.options.empty_type(array) string

structures type.structure-reference | type.structure

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.

ArrayInput.disable_add boolean

Hides the add button, and context menu actions on each item for adding new items to this Input.

disable_remove boolean

Hides the context menu actions on each item for removing them.

disable_reorder boolean

Hides the controls on each item for moving them.

AutoInput object

Provides a default user interface based on the data contained.

type string required

Sets an input type, which controls how this input appears and behaves.

Constant: "auto"

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options

Options that are specific to this type of input.

UnknownInput object

Provides a default user interface based on the data contained.

comment string

Changes the subtext below the Label. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.

context

All of: type._inputs.*.context object

documentation

Provides a custom link for documentation for editors shown above input.

All of: Documentation object

label string

Optionally changes the text above this input.

hidden boolean | string

Toggles the visibility of this input.

Default: false

disabled boolean | string

Toggles if this input can be edited.

Default: false

instance_value string

Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.

Values: "UUID" "NOW"

disable_instance_value_rehydration boolean

Prevents the default where inputs configured with an instance_value are rehydrated with a new value when duplicated in the CMS.

Default: false

cascade boolean

Specifies whether or not this input configuration should be merged with any matching, less specific configuration.

Default: true

options

Options that are specific to this type of input.

type._enabled_editors EditorKey[]

Set a preferred editor and/or disable the others. The first value sets which editor opens by default, and the following values specify which editors are accessible.

type._editables object

Configuration for editable regions in the Visual Editor, including content, block, link, image, and text editing options.

content object

Contains input options for the Content Editor.

44 nested properties

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

paths

All of: Paths object

bold boolean

Enables a control to set selected text to bold.

Default: true

copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

Default: false

italic boolean

Enables a control to italicize selected text.

Default: true

link boolean

Enables a control to create hyperlinks around selected text.

Default: true

redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

Default: true

strike boolean

Enables a control to strike selected text.

Default: false

subscript boolean

Enables a control to set selected text to subscript.

Default: false

superscript boolean

Enables a control to set selected text to superscript.

Default: false

underline boolean

Enables a control to underline selected text.

Default: false

undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

blockquote boolean

Enables a control to wrap blocks of text in block quotes.

Default: true

bulletedlist boolean

Enables a control to insert an unordered list, or to convert selected blocks of text into a unordered list.

Default: true

center string

Enables a control to center align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

code_inline boolean

Enables a control to create an inline code element, containing any selected text.

Default: false

code_block boolean

Enables a control to insert a code block.

Default: false

code boolean

Enables both block and inline code controls: code_block and code_inline.

Default: false

embed boolean

Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.

Default: false

format string

Enables a drop down menu for structured text. Has options for "p", "h1", "h2", "h3", "h4", "h5", "h6". Set as space separated options (e.g. "p h1 h2").

Default: "p h1 h2 h3 h4 h5 h6"

horizontalrule boolean

Enables a control to insert a horizontal rule.

Default: false

image boolean

Enables a control to insert an image. The image can be uploaded, existing or an external link.

Default: true

indent boolean

Enables a control to increase indentation for numbered and unordered lists.

Default: false

justify string

Enables a control to justify text by toggling a class name for a block of text. The value is the class name the editor should add to justify the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

left string

Enables a control to left align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

numberedlist boolean

Enables a control to insert a numbered list, or to convert selected blocks of text into a numbered list.

Default: true

outdent boolean

Enables a control to reduce indentation for numbered and unordered lists.

Default: false

right string

Enables a control to right align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

snippet boolean

Enables a control to insert snippets, if any are available.

Default: true

styles string

Enables a drop down menu for editors to style selected text or blocks or text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) to the CSS file containing the styles.

table boolean

Enables a control to insert a table. Further options for table cells are available in the context menu for cells within the editor.

Default: false

join_above boolean

Enables a control to join the selected block with the block above it.

Default: false

join_below boolean

Enables a control to join the selected block with the block below it.

Default: false

block object

Contains input options for block Editable Regions.

44 nested properties

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

paths

All of: Paths object

bold boolean

Enables a control to set selected text to bold.

Default: true

copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

Default: false

italic boolean

Enables a control to italicize selected text.

Default: true

link boolean

Enables a control to create hyperlinks around selected text.

Default: true

redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

Default: true

strike boolean

Enables a control to strike selected text.

Default: false

subscript boolean

Enables a control to set selected text to subscript.

Default: false

superscript boolean

Enables a control to set selected text to superscript.

Default: false

underline boolean

Enables a control to underline selected text.

Default: false

undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

blockquote boolean

Enables a control to wrap blocks of text in block quotes.

Default: true

bulletedlist boolean

Enables a control to insert an unordered list, or to convert selected blocks of text into a unordered list.

Default: true

center string

Enables a control to center align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

code_inline boolean

Enables a control to create an inline code element, containing any selected text.

Default: false

code_block boolean

Enables a control to insert a code block.

Default: false

code boolean

Enables both block and inline code controls: code_block and code_inline.

Default: false

embed boolean

Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.

Default: false

format string

Enables a drop down menu for structured text. Has options for "p", "h1", "h2", "h3", "h4", "h5", "h6". Set as space separated options (e.g. "p h1 h2").

Default: "p h1 h2 h3 h4 h5 h6"

horizontalrule boolean

Enables a control to insert a horizontal rule.

Default: false

image boolean

Enables a control to insert an image. The image can be uploaded, existing or an external link.

Default: true

indent boolean

Enables a control to increase indentation for numbered and unordered lists.

Default: false

justify string

Enables a control to justify text by toggling a class name for a block of text. The value is the class name the editor should add to justify the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

left string

Enables a control to left align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

numberedlist boolean

Enables a control to insert a numbered list, or to convert selected blocks of text into a numbered list.

Default: true

outdent boolean

Enables a control to reduce indentation for numbered and unordered lists.

Default: false

right string

Enables a control to right align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

snippet boolean

Enables a control to insert snippets, if any are available.

Default: true

styles string

Enables a drop down menu for editors to style selected text or blocks or text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) to the CSS file containing the styles.

table boolean

Enables a control to insert a table. Further options for table cells are available in the context menu for cells within the editor.

Default: false

join_above boolean

Enables a control to join the selected block with the block above it.

Default: false

join_below boolean

Enables a control to join the selected block with the block below it.

Default: false

link object

Contains input options for link Editable Regions.

1 nested properties

paths

All of: Paths object

image object

Contains input options for image Editable Regions.

10 nested properties

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

paths

All of: Paths object

text object

Contains input options for text Editable Regions.

14 nested properties

paths

All of: Paths object

bold boolean

Enables a control to set selected text to bold.

Default: true

copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

Default: false

italic boolean

Enables a control to italicize selected text.

Default: true

link boolean

Enables a control to create hyperlinks around selected text.

Default: true

redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

Default: true

strike boolean

Enables a control to strike selected text.

Default: false

subscript boolean

Enables a control to set selected text to subscript.

Default: false

superscript boolean

Enables a control to set selected text to superscript.

Default: false

underline boolean

Enables a control to underline selected text.

Default: false

undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

ContentEditable object

Contains input options for the Content Editor.

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

paths

All of: Paths object

bold boolean

Enables a control to set selected text to bold.

Default: true

copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

Default: false

italic boolean

Enables a control to italicize selected text.

Default: true

link boolean

Enables a control to create hyperlinks around selected text.

Default: true

redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

Default: true

strike boolean

Enables a control to strike selected text.

Default: false

subscript boolean

Enables a control to set selected text to subscript.

Default: false

superscript boolean

Enables a control to set selected text to superscript.

Default: false

underline boolean

Enables a control to underline selected text.

Default: false

undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

blockquote boolean

Enables a control to wrap blocks of text in block quotes.

Default: true

bulletedlist boolean

Enables a control to insert an unordered list, or to convert selected blocks of text into a unordered list.

Default: true

center string

Enables a control to center align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

code_inline boolean

Enables a control to create an inline code element, containing any selected text.

Default: false

code_block boolean

Enables a control to insert a code block.

Default: false

code boolean

Enables both block and inline code controls: code_block and code_inline.

Default: false

embed boolean

Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.

Default: false

format string

Enables a drop down menu for structured text. Has options for "p", "h1", "h2", "h3", "h4", "h5", "h6". Set as space separated options (e.g. "p h1 h2").

Default: "p h1 h2 h3 h4 h5 h6"

horizontalrule boolean

Enables a control to insert a horizontal rule.

Default: false

image boolean

Enables a control to insert an image. The image can be uploaded, existing or an external link.

Default: true

indent boolean

Enables a control to increase indentation for numbered and unordered lists.

Default: false

justify string

Enables a control to justify text by toggling a class name for a block of text. The value is the class name the editor should add to justify the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

left string

Enables a control to left align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

numberedlist boolean

Enables a control to insert a numbered list, or to convert selected blocks of text into a numbered list.

Default: true

outdent boolean

Enables a control to reduce indentation for numbered and unordered lists.

Default: false

right string

Enables a control to right align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

snippet boolean

Enables a control to insert snippets, if any are available.

Default: true

styles string

Enables a drop down menu for editors to style selected text or blocks or text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) to the CSS file containing the styles.

table boolean

Enables a control to insert a table. Further options for table cells are available in the context menu for cells within the editor.

Default: false

join_above boolean

Enables a control to join the selected block with the block above it.

Default: false

join_below boolean

Enables a control to join the selected block with the block below it.

Default: false

BlockEditable object

Contains input options for block Editable Regions.

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

paths

All of: Paths object

bold boolean

Enables a control to set selected text to bold.

Default: true

copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

Default: false

italic boolean

Enables a control to italicize selected text.

Default: true

link boolean

Enables a control to create hyperlinks around selected text.

Default: true

redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

Default: true

strike boolean

Enables a control to strike selected text.

Default: false

subscript boolean

Enables a control to set selected text to subscript.

Default: false

superscript boolean

Enables a control to set selected text to superscript.

Default: false

underline boolean

Enables a control to underline selected text.

Default: false

undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

blockquote boolean

Enables a control to wrap blocks of text in block quotes.

Default: true

bulletedlist boolean

Enables a control to insert an unordered list, or to convert selected blocks of text into a unordered list.

Default: true

center string

Enables a control to center align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

code_inline boolean

Enables a control to create an inline code element, containing any selected text.

Default: false

code_block boolean

Enables a control to insert a code block.

Default: false

code boolean

Enables both block and inline code controls: code_block and code_inline.

Default: false

embed boolean

Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.

Default: false

format string

Enables a drop down menu for structured text. Has options for "p", "h1", "h2", "h3", "h4", "h5", "h6". Set as space separated options (e.g. "p h1 h2").

Default: "p h1 h2 h3 h4 h5 h6"

horizontalrule boolean

Enables a control to insert a horizontal rule.

Default: false

image boolean

Enables a control to insert an image. The image can be uploaded, existing or an external link.

Default: true

indent boolean

Enables a control to increase indentation for numbered and unordered lists.

Default: false

justify string

Enables a control to justify text by toggling a class name for a block of text. The value is the class name the editor should add to justify the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

left string

Enables a control to left align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

numberedlist boolean

Enables a control to insert a numbered list, or to convert selected blocks of text into a numbered list.

Default: true

outdent boolean

Enables a control to reduce indentation for numbered and unordered lists.

Default: false

right string

Enables a control to right align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

snippet boolean

Enables a control to insert snippets, if any are available.

Default: true

styles string

Enables a drop down menu for editors to style selected text or blocks or text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) to the CSS file containing the styles.

table boolean

Enables a control to insert a table. Further options for table cells are available in the context menu for cells within the editor.

Default: false

join_above boolean

Enables a control to join the selected block with the block above it.

Default: false

join_below boolean

Enables a control to join the selected block with the block below it.

Default: false

LinkEditable object

Contains input options for link Editable Regions.

paths

All of: Paths object

ImageEditable object

Contains input options for image Editable Regions.

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

paths

All of: Paths object

TextEditable object

Contains input options for text Editable Regions.

paths

All of: Paths object

bold boolean

Enables a control to set selected text to bold.

Default: true

copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

Default: false

italic boolean

Enables a control to italicize selected text.

Default: true

link boolean

Enables a control to create hyperlinks around selected text.

Default: true

redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

Default: true

strike boolean

Enables a control to strike selected text.

Default: false

subscript boolean

Enables a control to set selected text to subscript.

Default: false

superscript boolean

Enables a control to set selected text to superscript.

Default: false

underline boolean

Enables a control to underline selected text.

Default: false

undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

type._editables_from_glob string[]

filter object | string

Controls which files are displayed in the collection list. Does not change which files are assigned to this collection.

singular_key string

Overrides the default singular input key of the collection. This is used for naming conventions for select and multiselect inputs.

output boolean

Specifies whether this collection's source files build to output files. Defaults to false.

collection_groups CollectionGroup[]

CollectionGroup object

heading string required

Short, descriptive label for this group of Collections.

collections string[] required

The collections shown in the sidebar for this group. Collections here are referenced by their key within collections_config.

base_url string

file_config FileConfigEntry[]

FileConfigEntry object

glob string[] | string required

The glob pattern(s) targeting a path to one or more files.

_inputs

All of: Inputs object

_inputs_from_glob

All of: type._inputs_from_glob string[]

_select_data

All of: Select Data object

_structures

All of: Structures object

_structures_from_glob

All of: type._structures_from_glob string[]

_enabled_editors EditorKey[]

Set a preferred editor and/or disable the others. The first value sets which editor opens by default, and the following values specify which editors are accessible.

uniqueItems=true

_editables object

Configuration for editable regions in the Visual Editor, including content, block, link, image, and text editing options.

5 nested properties

content object

Contains input options for the Content Editor.

44 nested properties

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

paths

All of: Paths object

bold boolean

Enables a control to set selected text to bold.

Default: true

copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

Default: false

italic boolean

Enables a control to italicize selected text.

Default: true

link boolean

Enables a control to create hyperlinks around selected text.

Default: true

redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

Default: true

strike boolean

Enables a control to strike selected text.

Default: false

subscript boolean

Enables a control to set selected text to subscript.

Default: false

superscript boolean

Enables a control to set selected text to superscript.

Default: false

underline boolean

Enables a control to underline selected text.

Default: false

undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

blockquote boolean

Enables a control to wrap blocks of text in block quotes.

Default: true

bulletedlist boolean

Enables a control to insert an unordered list, or to convert selected blocks of text into a unordered list.

Default: true

center string

Enables a control to center align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

code_inline boolean

Enables a control to create an inline code element, containing any selected text.

Default: false

code_block boolean

Enables a control to insert a code block.

Default: false

code boolean

Enables both block and inline code controls: code_block and code_inline.

Default: false

embed boolean

Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.

Default: false

format string

Enables a drop down menu for structured text. Has options for "p", "h1", "h2", "h3", "h4", "h5", "h6". Set as space separated options (e.g. "p h1 h2").

Default: "p h1 h2 h3 h4 h5 h6"

horizontalrule boolean

Enables a control to insert a horizontal rule.

Default: false

image boolean

Enables a control to insert an image. The image can be uploaded, existing or an external link.

Default: true

indent boolean

Enables a control to increase indentation for numbered and unordered lists.

Default: false

justify string

Enables a control to justify text by toggling a class name for a block of text. The value is the class name the editor should add to justify the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

left string

Enables a control to left align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

numberedlist boolean

Enables a control to insert a numbered list, or to convert selected blocks of text into a numbered list.

Default: true

outdent boolean

Enables a control to reduce indentation for numbered and unordered lists.

Default: false

right string

Enables a control to right align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

snippet boolean

Enables a control to insert snippets, if any are available.

Default: true

styles string

Enables a drop down menu for editors to style selected text or blocks or text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) to the CSS file containing the styles.

table boolean

Enables a control to insert a table. Further options for table cells are available in the context menu for cells within the editor.

Default: false

join_above boolean

Enables a control to join the selected block with the block above it.

Default: false

join_below boolean

Enables a control to join the selected block with the block below it.

Default: false

block object

Contains input options for block Editable Regions.

44 nested properties

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

paths

All of: Paths object

bold boolean

Enables a control to set selected text to bold.

Default: true

copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

Default: false

italic boolean

Enables a control to italicize selected text.

Default: true

link boolean

Enables a control to create hyperlinks around selected text.

Default: true

redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

Default: true

strike boolean

Enables a control to strike selected text.

Default: false

subscript boolean

Enables a control to set selected text to subscript.

Default: false

superscript boolean

Enables a control to set selected text to superscript.

Default: false

underline boolean

Enables a control to underline selected text.

Default: false

undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

blockquote boolean

Enables a control to wrap blocks of text in block quotes.

Default: true

bulletedlist boolean

Enables a control to insert an unordered list, or to convert selected blocks of text into a unordered list.

Default: true

center string

Enables a control to center align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

code_inline boolean

Enables a control to create an inline code element, containing any selected text.

Default: false

code_block boolean

Enables a control to insert a code block.

Default: false

code boolean

Enables both block and inline code controls: code_block and code_inline.

Default: false

embed boolean

Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.

Default: false

format string

Enables a drop down menu for structured text. Has options for "p", "h1", "h2", "h3", "h4", "h5", "h6". Set as space separated options (e.g. "p h1 h2").

Default: "p h1 h2 h3 h4 h5 h6"

horizontalrule boolean

Enables a control to insert a horizontal rule.

Default: false

image boolean

Enables a control to insert an image. The image can be uploaded, existing or an external link.

Default: true

indent boolean

Enables a control to increase indentation for numbered and unordered lists.

Default: false

justify string

Enables a control to justify text by toggling a class name for a block of text. The value is the class name the editor should add to justify the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

left string

Enables a control to left align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

numberedlist boolean

Enables a control to insert a numbered list, or to convert selected blocks of text into a numbered list.

Default: true

outdent boolean

Enables a control to reduce indentation for numbered and unordered lists.

Default: false

right string

Enables a control to right align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the styles file to take effect outside of the input.

snippet boolean

Enables a control to insert snippets, if any are available.

Default: true

styles string

Enables a drop down menu for editors to style selected text or blocks or text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) to the CSS file containing the styles.

table boolean

Enables a control to insert a table. Further options for table cells are available in the context menu for cells within the editor.

Default: false

join_above boolean

Enables a control to join the selected block with the block above it.

Default: false

join_below boolean

Enables a control to join the selected block with the block below it.

Default: false

link object

Contains input options for link Editable Regions.

1 nested properties

paths

All of: Paths object

image object

Contains input options for image Editable Regions.

10 nested properties

mime_type string

Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.

Values: "image/jpeg" "image/png" "image/webp"

resize_style string

Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.

Default: "contain"

Values: "cover" "contain" "stretch" "crop"

width number

Defines the width of the bounding box used in the image resizing process defined with resize_style.

height number

Defines the height of the bounding box used in the image resizing process defined with resize_style.

expandable boolean

Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.

Default: false

image_size_attributes boolean

Instructs the editor to save width and height attributes on the image elements. This can prevent pop-in as a page loads.

Default: true

allowed_sources string[]

If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.

prevent_resize_existing_files boolean

Enable to skip the image resizing process configured for this input when selecting existing images.

Default: false

sizes object[]

Definitions for creating additional images of different sizes when uploading or selecting existing files.

paths

All of: Paths object

text object

Contains input options for text Editable Regions.

14 nested properties

paths

All of: Paths object

bold boolean

Enables a control to set selected text to bold.

Default: true

copyformatting boolean

Enables a control to copy formatting from text to other text. Only applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not copy other styles or formatting.

Default: false

italic boolean

Enables a control to italicize selected text.

Default: true

link boolean

Enables a control to create hyperlinks around selected text.

Default: true

redo boolean

Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

removeformat boolean

Enables the control to remove formatting from text. Applies to formatting from bold, italic, underline, strike, subscript, and superscript. Does not remove other styles or formatting.

Default: true

strike boolean

Enables a control to strike selected text.

Default: false

subscript boolean

Enables a control to set selected text to subscript.

Default: false

superscript boolean

Enables a control to set selected text to superscript.

Default: false

underline boolean

Enables a control to underline selected text.

Default: false

undo boolean

Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Default: false

remove_custom_markup boolean

Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having allow_custom_markup turned on disables this option. Defaults to false.

allow_custom_markup boolean

Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.

_editables_from_glob

All of: type._editables_from_glob string[]

editor object

default_path string required

Default: "/"

editor.default_path string

source_editor object

tab_size number

Default: 2

theme

Default: "basic_dark"

All of: Theme string

show_gutter boolean

Default: true

soft_wrap boolean

Default: false

commit_templates object[]

upstream_commit_template string

markdown object

Configuration for Markdown processing engines and formatting options.

engine string

The flavor of Markdown to use to convert between HTML and Markdown.

Default: "commonmark"

Values: "commonmark" "kramdown"

options object

19 nested properties

html boolean

Output HTML tags from source.

Default: false

xhtml boolean

Use / to close single tags (e.g. <br />).

Default: false

breaks boolean

Convert \n in paragraphs into <br>.

Default: false

linkify boolean

Autoconvert URL-like text to links.

Default: false

typographer boolean

Enable some language-neutral replacement, as well as quotes beautification.

Default: false

quotes string

Double + single quotes replacement pairs, when typographer enabled and smartquotes on. For example, you can use "«»„"" for Russian, ""„"‚"" for German, and ["«\xA0", "\xA0»", "‹\xA0", "\xA0›"] for French (including nbsp).

spaced_lists boolean

Output lists with an extra space in Markdown.

Default: false

sentence_per_line boolean

Add linebreaks between sentences in Markdown.

Default: false

gfm boolean

Enable GFM mode.

code_block_fences string

Determines which style of code block fences to use.

Values: "```" "~~~"

treat_indentation_as_code boolean

Determines whether 4 spaces on indentation should be read as a code block.

Default: false

escape_snippets_in_code_blocks boolean

Render snippets as plain text within code blocks.

Default: false

table boolean

Output tables in Markdown format.

Default: false

strikethrough boolean

Output strikes in wrapped in double tildes (e.g. ~~strike~~).

Default: false

subscript boolean

Output subscript in wrapped in tildes (e.g. ~sub~).

Default: false

superscript boolean

Output superscript in wrapped in carets (e.g. ^super^).

Default: false

heading_ids boolean

Generate IDs for headings.

Default: false

attributes boolean

Save element attributes in Markdown format instead of converting to HTML.

Default: false

attribute_elements Record<string, string>

Define positioning behavior of Markdown attributes for different elements.

2 nested properties

inline

All of: Attribute List Position string

block

All of: Attribute List Position string

AttributeListPosition string

Positioning options for Markdown attribute elements.

type._snippets Record<string, object>

Configuration for custom snippets.

type.snippet object

A snippet configuration.

_inputs

All of: Inputs object

_inputs_from_glob

All of: type._inputs_from_glob string[]

_select_data

All of: Select Data object

_structures

All of: Structures object

_structures_from_glob

All of: type._structures_from_glob string[]

preview

All of: Preview object

picker_preview

All of: Picker Preview

snippet string

The snippet string contains the text to match for your snippet, with any dynamic sections represented using a placeholder in double square brackets.

template string

The template that this snippet should inherit, out of the available Snippet Templates.

inline boolean

Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat this snippet as a block-level element in the content editor.

Default: false

view string

Controls how selected items are rendered. Defaults to 'card', or 'inline' if inline is true.

Values: "card" "inline" "gallery"

strict_whitespace boolean

Whether this snippet treats whitespace as-is or not.

definitions Record<string, any>

The variables required for the selected template.

alternate_formats type.snippet[]

Alternate configurations for this snippet.

The parameters of this snippet.

SnippetAlternateFormats type.snippet[]

Alternate configurations for this snippet.

type.snippet-model object

source_key string

editor_key string

remove_empty boolean

Default: false

optional boolean

Default: false

type string

Values: "array" "object" "string" "boolean" "number"

allowed_values array

implied_boolean boolean

Default: false

default

type.snippet-format object

root_boundary object

2 nested properties

start string

Default: ""

end string

Default: ""

root_value_boundary object

2 nested properties

start string

Default: ""

end string

Default: ""

root_value_boundary_optional Record<string, boolean>

root_value_delimiter string

root_pair_delimiter string[]

remove_empty_root_boundary boolean

object_boundary object

2 nested properties

start string

Default: ""

end string

Default: ""

object_value_delimiter string

object_pair_delimiter string

array_boundary object

2 nested properties

start string

Default: ""

end string

Default: ""

array_delimiter string

string_boundary string[]

string_escape_character string

allow_booleans boolean

allow_numbers boolean

allow_implied_values boolean

allow_null boolean

forbidden_tokens string[]

allowed_string_cases object

5 nested properties

any boolean

leading_upper boolean

leading_lower boolean

lower boolean

upper boolean

type.snippet-style object

output string required

Values: "legacy" "inline" "block"

inline object

2 nested properties

leading string

trailing string

block object

3 nested properties

leading string

trailing string

indent string

type._snippets_imports object

hugo type._snippets_imports.*.(full-import) | object | object

uniqueItems=true

jekyll type._snippets_imports.*.(full-import) | object | object

uniqueItems=true

mdx type._snippets_imports.*.(full-import) | object | object

uniqueItems=true

eleventy_liquid type._snippets_imports.*.(full-import) | object | object

uniqueItems=true

eleventy_nunjucks type._snippets_imports.*.(full-import) | object | object

uniqueItems=true

markdoc type._snippets_imports.*.(full-import) | object | object

uniqueItems=true

python_markdown_extensions type._snippets_imports.*.(full-import) | object | object

uniqueItems=true

docusaurus_mdx type._snippets_imports.*.(full-import) | object | object

uniqueItems=true

_snippets_imports.hugo type._snippets_imports.*.(full-import) | object | object

type._snippets_imports.*.(full-import) boolean

SnippetImportExclude string[]

The list of excluded snippets. If unset, all snippets are excluded unless defined in include.

SnippetImportInclude string[]

The list of included snippets. If unset, all snippets are included unless defined in exclude.

_snippets_imports.jekyll type._snippets_imports.*.(full-import) | object | object

_snippets_imports.mdx type._snippets_imports.*.(full-import) | object | object

_snippets_imports.eleventy_liquid type._snippets_imports.*.(full-import) | object | object

_snippets_imports.eleventy_nunjucks type._snippets_imports.*.(full-import) | object | object

_snippets_imports.markdoc type._snippets_imports.*.(full-import) | object | object

_snippets_imports.python_markdown_extensions type._snippets_imports.*.(full-import) | object | object

_snippets_imports.docusaurus_mdx type._snippets_imports.*.(full-import) | object | object

type._snippets_templates Record<string, object>

Extended option used when creating more complex custom snippets.

A record of reusable values that can be referenced in snippet templates. Values are substituted using { ref: "key" } for direct replacement or { spread_ref: "key" } for spreading arrays/objects.

A reusable value that can be referenced in snippet templates via { ref: "key" } or { spread_ref: "key" }.

type.snippet-definition-select-value object

A value option for select inputs, typically used in language lists.

value string | number | boolean required

The value for this option.

name string

The display name for this option.

collections_config_override boolean

Prevents CloudCannon from automatically discovering collections for supported SSGs if true. Defaults to false.

Properties

Definitions