Developer ReferenceConfiguration File

text

On this page

Description:

This key defines input options for text Editable Regions.

Appears in:
└── _editables
    └── text
Type:
Object
Properties:
allow_custom_markupboolean#

This key toggles whether CloudCannon will allow you to edit custom markup in rich text editors and explicitly accept the risk of unintentionally deleting elements that cannot be recreated.

Setting this key to true will enable editing of custom markup. When using allow_custom_markup outside of editable regions, content that uses JavaScript will not be editable for security reasons. These inputs will appear as uneditable snippets.

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

boldboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to bold selected text.

Setting this key to true will enable a tool in your WYSIWYG toolbar to bold selected text.

Defaults to: true

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

copyformattingboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to copy formatting from selected text.

Setting this key to true will enable a tool in your WYSIWYG toolbar to copy formatting from selected text. Applies to bold, italic, underline, strike, subscript, and superscript formatting. Does not copy other styles or formatting.

Defaults to: false

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

italicboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to italicize selected text.

Setting this key to true will enable a tool in your WYSIWYG toolbar to italicize selected text.

Defaults to: true

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

linkboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to create a hyperlink around selected text.

Setting this key to true will enable a tool in your WYSIWYG toolbar to create a hyperlink around selected text.

Defaults to: true

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

link_optionsObject#

Configure the controls to edit hyperlinks around selected text.

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

pathsObject#

This key defines paths for your Rich Text editors or File inputs.

If undefined at higher levels of the configuration cascade, paths will default to any values configured in the CloudCannon configuration file.

Appears in: Rich Text Input options, URL Input options, File Input options, _editables.content, _editables.block, _editables.link, _editables.image, _editables.text.

Show examplesHide examples

In this example, we have configured paths for the blog Collection to set custom upload and static paths.

Copied to clipboard
collections_config:
  blog:
    paths:
      uploads: /uploads/blog/
      static: /assets/
{
  "collections_config": {
    "blog": {
      "paths": {
        "uploads": "/uploads/blog/",
        "static": "/assets/"
      }
    }
  }
}
redoboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to redo recent edits undone with undo.

Setting this key to true will enable a tool in your WYSIWYG toolbar to redo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Defaults to: false

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

remove_custom_markupboolean#

This key toggles whether CloudCannon will allow you to strip custom markup from content edited in a rich text editor, allowing you to clean files of unnecessary HTML content.

Setting this key to true will enable stripping custom markup from content. The remove_custom_markup key is disabled if allow_custom_markup is enabled.

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

removeformatboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to remove formatting from selected text.

Setting this key to true will enable a tool in your WYSIWYG toolbar to remove formatting. Applies to bold, italic, underline, strike, subscript, and superscript formatting. Does not remove other styles or formatting.

Defaults to: true

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

strikeboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to strike through selected text.

Setting this key to true will enable a tool in your WYSIWYG toolbar to strike through selected text.

Defaults to: false

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

subscriptboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to subscript selected text.

Setting this key to true will enable a tool in your WYSIWYG toolbar to subscript selected text.

Defaults to: false

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

superscriptboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to superscript selected text.

Setting this key to true will enable a tool in your WYSIWYG toolbar to superscript selected text.

Defaults to: false

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

underlineboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to underline selected text.

Setting this key to true will enable a tool in your WYSIWYG toolbar to underline selected text.

Defaults to: false

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

undoboolean#

This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to undo recent edits.

Setting this key to true will enable a tool in your WYSIWYG toolbar to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.

Defaults to: false

Appears in: Rich Text Input options, _editables.content, _editables.block, _editables.text.

Examples:
Open in a new tab