CloudCannon Configuration (Editables) (SchemaStore) JSON Schema

Type	type._editables
File match	`cloudcannon.editables.yml` `cloudcannon.editables.yaml` `cloudcannon.editables.json` `.cloudcannon.editables.yml` `.cloudcannon.editables.yaml` `*.cloudcannon.editables.json`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/cloudcannon-configuration-editables/latest.json
Source	https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-editables.schema.json

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

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

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

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.

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 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.

Validate with Lintel

Definitions