Skip to content

Email JSON

This page documents the email JSON schema of the Chamaileon SDK.

The latest email JSON version is 4.1.0.

Document

Document Properties

PropertyTypeValuesDescription
bodyobjectRead moresee body element for more details
variablesarrayRead moreclick link for more details
componentsarrayRead moreclick link for more details
fontFilesobjectkey is the font name (first element in font stack), value is the font URLany valid css font
titlestringstringany string
subjectLinestringstringany string
previewTextstringstringany string
generatorOptionsobjectRead moreclick link for more details

Document Default

js
const default = {
	body: {
		eid: "root",
		type: "body",
		children: [],
		version: "4.1.0",
		attrs: {},
		style: {
			backgroundColor: "",
			backgroundRepeat: "no-repeat",
			backgroundPosition: "center center",
			backgroundImage: "",
			backgroundSize: "auto",
			bodyWidth: 600,
		},
	},
	variables: [],
	components: [],
	fontFiles: {},
	title: "Default title",
};

Blocks

Block Properties

PropertyTypeValuesDescription
_idstringstringhas to be unique withing the block library
bodyobjectRead morehas to start with fullwidth or block-level-conditional or block-level-loop, cannot start with anything else
fontFilesobjectkey is the font name (first element in font stack), value is the font URLany valid css font
titlestringstringany string
placeholderarrayarray of objectsarray of elements, should start with fullwidth or block-level-conditional or block-level-loop, cannot start with body, column, branch. This is used to show different content inside the editor that hides the children content
versionstringstringEmail JSON version that it was created on

Block example

js
const example = {
  _id: "",
  title: "Default title",
  body: {
    eid: "example",
    type: "fullwidth",
    style: {
      backgroundColor: "",
      backgroundRepeat: "no-repeat",
      backgroundPosition: "center center",
      backgroundImage: "",
      backgroundSize: "auto",
      contentBackgroundColor: "",
      contentBackgroundRepeat: "no-repeat",
      contentBackgroundPosition: "center center",
      contentBackgroundImage: "",
      contentBackgroundSize: "auto",
      contentBorderRadius: "0px",
      contentBorderLeftColor: "#121212",
      contentBorderLeftStyle: "solid",
      contentBorderLeftWidth: "0px",
      contentBorderBottomColor: "#121212",
      contentBorderBottomStyle: "solid",
      contentBorderBottomWidth: "0px",
      contentBorderRightColor: "#121212",
      contentBorderRightStyle: "solid",
      contentBorderRightWidth: "0px",
      contentBorderTopColor: "#121212",
      contentBorderTopStyle: "solid",
      contentBorderTopWidth: "0px",
      contentMarginLeft: "0px",
      contentMarginBottom: "0px",
      contentMarginRight: "0px",
      contentMarginTop: "0px",
      contentPaddingLeft: "0px",
      contentPaddingBottom: "0px",
      contentPaddingRight: "0px",
      contentPaddingTop: "0px",
      contentWidth: null,
    },
    attrs: {
      hideOnMobile: false,
      hideOnDesktop: false,
      lock: false,
      marker: "",
    },
    children: [],
    placeholder: [],
    customData: {},
  },
  fontFiles: {},
  placeholder: [],
  version: "4.1.0"
}

Variables

Color Variable

Color Variable Properties

PropertyTypeValuesDescription
namestringstringany string, without special characters, has to be unique
valuestringHEX color, color variable, "transparent"any HEX color that follows the format #ABABAB, "transparent",
typestringstringhas to be "color"
js
const example = {
  name: "example",
  value: "#ABABAB",
  type: "color"
}

Color Variable Properties in element style or attr prop

PropertyTypeValuesDescription
referencestringstringthe name of the variable
defaultstringHEX color, color variable, "transparent"any HEX color that follows the format #ABABAB, "transparent", when the variable is not found this will be used
js
const example = {
  reference: "example",
  default: "#ABABAB"
}

Image Variable

Image Variable Properties

PropertyTypeValuesDescription
namestringstringany string, without special characters, has to be unique
valuestringURLany image URL
typestringstringhas to be "image"
js
const example = {
  name: "example",
  value: "https://placehold.co/150x150.png",
  type: "image"
}

Image Variable Properties in element style or attr prop

PropertyTypeValuesDescription
referencestringstringthe name of the variable
defaultstringURLany image URL, when the variable is not found this will be used
js
const example = {
  reference: "example",
  default: "https://placehold.co/150x150.png"
}

Font Stack Variable

Font Stack Variable Properties

PropertyTypeValuesDescription
namestringstringany string, without special characters, has to be unique
valuestringstringany font stack
typestringstringhas to be "fontStack"
js
const example = {
  name: "example",
  value: "Arial, Helvetica Neue, Helvetica, sans-serif",
  type: "fontStack"
}

Font Stack Variable Properties in element style or attr prop

PropertyTypeValuesDescription
referencestringstringthe name of the variable
defaultstringstringany font stack, when the variable is not found this will be used
js
const example = {
  reference: "example",
  default: "Arial, Helvetica Neue, Helvetica, sans-serif"
}
PropertyTypeValuesDescription
namestringstringany string, without special characters, has to be unique
valuestringstringany URL
typestringstringhas to be "link"
js
const example = {
  name: "example",
  value: "https://example.com",
  type: "fontStack"
}
PropertyTypeValuesDescription
referencestringstringthe name of the variable
defaultstringURLany URL, when the variable is not found this will be used
js
const example = {
  reference: "example",
  default: "https://example.com"
}

Text variable

Text Variable Properties

PropertyTypeValuesDescription
namestringstringany string, without special characters, has to be unique
valuestringstringany HTML or non-HTML string
typestringstringhas to be "text"
js
const example = {
  name: "example",
  value: "Example text",
  type: "fontStack"
}

Text Variable Properties in element style or attr prop

PropertyTypeValuesDescription
referencestringstringthe name of the variable
defaultstringstringany HTML or non-HTML string, when the variable is not found this will be used
js
const example = {
  reference: "example",
  default: "Example text"
}

Components

Button Component

Button Component Properties

PropertyTypeValuesDescription
namestringstringany string, without special characters
referencestring, nullstring, nullcomponent can reference another component with the same type and can define partial style objects (eg. the referenced component has every style defined, the component that references it only defines a different color)
typestringstringhas to be "button"
styleobjectobjectstyle from Button element style
versionstringstringEmail JSON version that it was created on
js
const example = {
  name: "example",
  reference: null,
  type: "button",
  style: {
    lineHeight: "25px",
		color: "#ffffff",
		fontSize: "18px",
		fontFamily: "Arial, Helvetica Neue, Helvetica, sans-serif",
		letterSpacing: "normal",
		backgroundColor: "#0094c5",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		borderRadius: "5px",
		borderLeftColor: "#121212",
		borderLeftStyle: "solid",
		borderLeftWidth: "0px",
		borderBottomColor: "#121212",
		borderBottomStyle: "solid",
		borderBottomWidth: "0px",
		borderRightColor: "#121212",
		borderRightStyle: "solid",
		borderRightWidth: "0px",
		borderTopColor: "#121212",
		borderTopStyle: "solid",
		borderTopWidth: "0px",
		marginLeft: "20px",
		marginBottom: "20px",
		marginRight: "20px",
		marginTop: "20px",
		paddingLeft: "15px",
		paddingBottom: "15px",
		paddingRight: "15px",
		paddingTop: "15px",
		hoverBackgroundColor: "",
		sizeType: "FIT_TO_TEXT",
		fullWidthOnMobile: true,
		align: "center",
		bold: false,
		italic: false,
		underline: false,
    width: null
  },
  version: "4.1.0"
}

Button Component Properties in element style

PropertyTypeValuesDescription
referencestringstringthe name of the component
modifiedbooleanbooleanshows if the element's style was modified
valueobjectstringcan have parts of Button element style, has values that are not part of the component that's referenced
defaultobjectobjectButton element style, used when the referenced component is not found
js
const example = {
  reference: "example",
  modified: false,
  value: {},
  default: {
      lineHeight: "25px",
      color: "#ffffff",
      fontSize: "18px",
      fontFamily: "Arial, Helvetica Neue, Helvetica, sans-serif",
      letterSpacing: "normal",
      backgroundColor: "#0094c5",
      backgroundRepeat: "no-repeat",
      backgroundPosition: "center center",
      backgroundImage: "",
      backgroundSize: "auto",
      borderRadius: "5px",
      borderLeftColor: "#121212",
      borderLeftStyle: "solid",
      borderLeftWidth: "0px",
      borderBottomColor: "#121212",
      borderBottomStyle: "solid",
      borderBottomWidth: "0px",
      borderRightColor: "#121212",
      borderRightStyle: "solid",
      borderRightWidth: "0px",
      borderTopColor: "#121212",
      borderTopStyle: "solid",
      borderTopWidth: "0px",
      marginLeft: "20px",
      marginBottom: "20px",
      marginRight: "20px",
      marginTop: "20px",
      paddingLeft: "15px",
      paddingBottom: "15px",
      paddingRight: "15px",
      paddingTop: "15px",
      hoverBackgroundColor: "",
      sizeType: "FIT_TO_TEXT",
      fullWidthOnMobile: true,
      align: "center",
      bold: false,
      italic: false,
      underline: false,
      width: null
  }
}

Divider Component

Divider Component Properties

PropertyTypeValuesDescription
namestringstringany string, without special characters
referencestring, nullstring, nullcomponent can reference another component with the same type and can define partial style objects (eg. the referenced component has every style defined, the component that references it only defines a different color)
typestringstringhas to be "divider"
styleobjectobjectstyle from Divider element style
versionstringstringEmail JSON version that it was created on
js
const example = {
  name: "example",
  reference: null,
  type: "divider",
  style: {
    width: "2px",
		type: "solid",
		color: "#a9a9a9",
		align: "center",
		backgroundColor: "",
		backgroundPosition: "center center",
		backgroundRepeat: "no-repeat",
		backgroundImage: "",
		backgroundSize: "auto",
		paddingTop: "10px",
		paddingRight: "10px",
		paddingBottom: "10px",
		paddingLeft: "10px",
  },
  version: "4.1.0"
}

Divider Component Properties in element style

PropertyTypeValuesDescription
referencestringstringthe name of the component
modifiedbooleanbooleanshows if the element's style was modified
valueobjectstringcan have parts of Divider element style, has values that are not part of the component that's referenced
defaultobjectobjectDivider element style, used when the referenced component is not found
js
const example = {
  reference: "example",
  modified: false,
  value: {},
  default: {
    width: "2px",
		type: "solid",
		color: "#a9a9a9",
		align: "center",
		backgroundColor: "",
		backgroundPosition: "center center",
		backgroundRepeat: "no-repeat",
		backgroundImage: "",
		backgroundSize: "auto",
		paddingTop: "10px",
		paddingRight: "10px",
		paddingBottom: "10px",
		paddingLeft: "10px",
  }
}

Image Component

Image Component Properties

PropertyTypeValuesDescription
namestringstringany string, without special characters
referencestring, nullstring, nullcomponent can reference another component with the same type and can define partial style objects (eg. the referenced component has every style defined, the component that references it only defines a different color)
typestringstringhas to be "image"
styleobjectobjectstyle from Image element style
versionstringstringEmail JSON version that it was created on
js
const example = {
  name: "example",
  reference: null,
  type: "image",
  style: {
    fullWidthOnMobile: false,
		align: "center",
		lockedWidth: null,
		lockedHeight: null,
		maxHeight: "300px",
		maxWidth: "300px",
		width: "150px",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		borderRadius: "0px",
		borderLeftColor: "#121212",
		borderLeftStyle: "solid",
		borderLeftWidth: "0px",
		borderBottomColor: "#121212",
		borderBottomStyle: "solid",
		borderBottomWidth: "0px",
		borderRightColor: "#121212",
		borderRightStyle: "solid",
		borderRightWidth: "0px",
		borderTopColor: "#121212",
		borderTopStyle: "solid",
		borderTopWidth: "0px",
		marginLeft: "0px",
		marginBottom: "0px",
		marginRight: "0px",
		marginTop: "0px",
		paddingLeft: "0px",
		paddingBottom: "0px",
		paddingRight: "0px",
		paddingTop: "0px",
  },
  version: "4.1.0"
}

Image Component Properties in element style

PropertyTypeValuesDescription
referencestringstringthe name of the component
modifiedbooleanbooleanshows if the element's style was modified
valueobjectstringcan have parts of Image element style, has values that are not part of the component that's referenced
defaultobjectobjectImage element style, used when the referenced component is not found
js
const example = {
  reference: "example",
  modified: false,
  value: {},
  default: {
    fullWidthOnMobile: false,
		align: "center",
		lockedWidth: null,
		lockedHeight: null,
		maxHeight: "300px",
		maxWidth: "300px",
		width: "150px",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		borderRadius: "0px",
		borderLeftColor: "#121212",
		borderLeftStyle: "solid",
		borderLeftWidth: "0px",
		borderBottomColor: "#121212",
		borderBottomStyle: "solid",
		borderBottomWidth: "0px",
		borderRightColor: "#121212",
		borderRightStyle: "solid",
		borderRightWidth: "0px",
		borderTopColor: "#121212",
		borderTopStyle: "solid",
		borderTopWidth: "0px",
		marginLeft: "0px",
		marginBottom: "0px",
		marginRight: "0px",
		marginTop: "0px",
		paddingLeft: "0px",
		paddingBottom: "0px",
		paddingRight: "0px",
		paddingTop: "0px",
  }
}

Typed Text Component

Typed Text Component Properties

PropertyTypeValuesDescription
namestringstringany string, without special characters
referencestring, nullstring, nullcomponent can reference another component with the same type and can define partial style objects (eg. the referenced component has every style defined, the component that references it only defines a different color)
typestringstringhas to be "typed-text"
styleobjectobjectstyle from Divider element style
versionstringstringEmail JSON version that it was created on
js
const example = {
  name: "example",
  reference: null,
  type: "typed-text",
  style: {
   subType: "paragraph",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		paddingLeft: "10px",
		paddingBottom: "5px",
		paddingRight: "10px",
		paddingTop: "5px",
		lineHeight: "25px",
		letterSpacing: "normal",
		color: "#131313",
		fontSize: "18px",
		fontFamily: "Arial, Helvetica Neue, Helvetica, sans-serif",
		linkTextDecoration: "underline",
		linkColor: "#00c0e7",
		listMarkerType: "disc",
		listMarkerFontSize: "18px",
		listMarkerColor: "#131313",
		listMarkerFontFamily: "Arial, Helvetica Neue, Helvetica, sans-serif",
		lineSpacing: "0px",
		align: "left",
		bold: false,
		italic: false,
		underline: false,
  },
  version: "4.1.0"
}

Typed Text Component Properties in element style

PropertyTypeValuesDescription
referencestringstringthe name of the component
modifiedbooleanbooleanshows if the element's style was modified
valueobjectstringcan have parts of Typed Text element style, has values that are not part of the component that's referenced
defaultobjectobjectTyped Text element style, used when the referenced component is not found
js
const example = {
  reference: "example",
  modified: false,
  value: {},
  default: {
    subType: "paragraph",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		paddingLeft: "10px",
		paddingBottom: "5px",
		paddingRight: "10px",
		paddingTop: "5px",
		lineHeight: "25px",
		letterSpacing: "normal",
		color: "#131313",
		fontSize: "18px",
		fontFamily: "Arial, Helvetica Neue, Helvetica, sans-serif",
		linkTextDecoration: "underline",
		linkColor: "#00c0e7",
		listMarkerType: "disc",
		listMarkerFontSize: "18px",
		listMarkerColor: "#131313",
		listMarkerFontFamily: "Arial, Helvetica Neue, Helvetica, sans-serif",
		lineSpacing: "0px",
		align: "left",
		bold: false,
		italic: false,
		underline: false,
  }
}

Video Component

Video Component Properties

PropertyTypeValuesDescription
namestringstringany string, without special characters
referencestring, nullstring, nullcomponent can reference another component with the same type and can define partial style objects (eg. the referenced component has every style defined, the component that references it only defines a different color)
typestringstringhas to be "video"
styleobjectobjectstyle from Video element style
versionstringstringEmail JSON version that it was created on
js
const example = {
  name: "example",
  reference: null,
  type: "video",
  style: {
    align: "center",
		iconColor: "#FF0000",
		iconSize: "50px",
		iconType: "youtube",
		lockedWidth: null,
		lockedHeight: null,
		maxHeight: "338px",
		maxWidth: "600px",
		width: "600px",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		borderRadius: "0px",
		borderLeftColor: "#121212",
		borderLeftStyle: "solid",
		borderLeftWidth: "0px",
		borderBottomColor: "#121212",
		borderBottomStyle: "solid",
		borderBottomWidth: "0px",
		borderRightColor: "#121212",
		borderRightStyle: "solid",
		borderRightWidth: "0px",
		borderTopColor: "#121212",
		borderTopStyle: "solid",
		borderTopWidth: "0px",
		marginLeft: "0px",
		marginBottom: "0px",
		marginRight: "0px",
		marginTop: "0px",
		paddingLeft: "0px",
		paddingBottom: "0px",
		paddingRight: "0px",
		paddingTop: "0px",
  },
  version: "4.1.0"
}

Video Component Properties in element style

PropertyTypeValuesDescription
referencestringstringthe name of the component
modifiedbooleanbooleanshows if the element's style was modified
valueobjectstringcan have parts of Video element style, has values that are not part of the component that's referenced
defaultobjectobjectVideo element style, used when the referenced component is not found
js
const example = {
  reference: "example",
  modified: false,
  value: {},
  default: {
    align: "center",
		iconColor: "#FF0000",
		iconSize: "50px",
		iconType: "youtube",
		lockedWidth: null,
		lockedHeight: null,
		maxHeight: "338px",
		maxWidth: "600px",
		width: "600px",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		borderRadius: "0px",
		borderLeftColor: "#121212",
		borderLeftStyle: "solid",
		borderLeftWidth: "0px",
		borderBottomColor: "#121212",
		borderBottomStyle: "solid",
		borderBottomWidth: "0px",
		borderRightColor: "#121212",
		borderRightStyle: "solid",
		borderRightWidth: "0px",
		borderTopColor: "#121212",
		borderTopStyle: "solid",
		borderTopWidth: "0px",
		marginLeft: "0px",
		marginBottom: "0px",
		marginRight: "0px",
		marginTop: "0px",
		paddingLeft: "0px",
		paddingBottom: "0px",
		paddingRight: "0px",
		paddingTop: "0px",
  }
}

Elements

Body

Body Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, has to be "root"
typestringstringelement type, has to be "body"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
childrenarrayarray of objectsarray of elements, should be fullwidth, block-level-conditional or block-level-loop
customDataobjectobjectany information that is not provided by our json

Body Style

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
bodyWidthnumberinteger600any integer

Body Attrs

Currently not in use.

Body Default

js
const default = {
  eid: "root",
  type: "body",
  style: {
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		bodyWidth: 600,
  },
  attrs: {},
  children: [],
  customData: {},
}

Fullwidth

Fullwidth Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "fullwidth"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
childrenarrayarray of objectsarray of elements, except fullwidth, block-level-conditional, block-level-loop, body, column, branch
placeholderarrayarray of objectsarray of elements, should start with fullwidth or block-level-conditional or block-level-loop,, cannot start with body, column, branch. This is used to show different content inside the editor that hides the children content
customDataobjectobjectany information that is not provided by our json

Fullwidth Style

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
contentBackgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
contentBackgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
contentBackgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
contentBackgroundImagestring, objectURL, image variable""any image URL, Image variable
contentBackgroundSizestringcss value"auto""auto", "contain", "cover"
contentBorderRadiusstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentBorderLeftColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
contentBorderLeftStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
contentBorderLeftWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentBorderBottomColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
contentBorderBottomStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
contentBorderBottomWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentBorderRightColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
contentBorderRightStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
contentBorderRightWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentBorderTopColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
contentBorderTopStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
contentBorderTopWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentMarginLeftstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentMarginBottomstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentMarginRightstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentMarginTopstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentPaddingLeftstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentPaddingBottomstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentPaddingRightstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentPaddingTopstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
contentWidthstring or nullinteger or nullnullany integer or null

Fullwidth Attrs

PropertyTypeValuesDefaultAcceptable values
hideOnMobilebooleanbooleanfalseboolean
hideOnDesktopbooleanbooleanfalseboolean
lockstring or booleanstring or booleanfalse"all", "design", true, false
markerstringany string""any string

Fullwidth Default

js
const default = {
  eid: "example",
  type: "fullwidth",
  style: {
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		contentBackgroundColor: "",
		contentBackgroundRepeat: "no-repeat",
		contentBackgroundPosition: "center center",
		contentBackgroundImage: "",
		contentBackgroundSize: "auto",
		contentBorderRadius: "0px",
		contentBorderLeftColor: "#121212",
		contentBorderLeftStyle: "solid",
		contentBorderLeftWidth: "0px",
		contentBorderBottomColor: "#121212",
		contentBorderBottomStyle: "solid",
		contentBorderBottomWidth: "0px",
		contentBorderRightColor: "#121212",
		contentBorderRightStyle: "solid",
		contentBorderRightWidth: "0px",
		contentBorderTopColor: "#121212",
		contentBorderTopStyle: "solid",
		contentBorderTopWidth: "0px",
		contentMarginLeft: "0px",
		contentMarginBottom: "0px",
		contentMarginRight: "0px",
		contentMarginTop: "0px",
		contentPaddingLeft: "0px",
		contentPaddingBottom: "0px",
		contentPaddingRight: "0px",
		contentPaddingTop: "0px",
		contentWidth: null,
  },
  attrs: {
    hideOnMobile: false,
		hideOnDesktop: false,
		lock: false,
		marker: "",
  },
  children: [],
  placeholder: [],
  customData: {},
}

Box

Box Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "box"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
childrenarrayarray of objectsarray of elements, except fullwidth, block-level-conditional, block-level-loop, body, column, branch
customDataobjectobjectany information that is not provided by our json

Box Style

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
borderRadiusstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderLeftColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderLeftStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderLeftWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderBottomColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderBottomStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderBottomWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderRightColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderRightStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderRightWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderTopColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderTopStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderTopWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginLeftstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginBottomstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginRightstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginTopstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingLeftstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingBottomstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingRightstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingTopstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px

Box Attrs

PropertyTypeValuesDefaultAcceptable values
hideOnMobilebooleanbooleanfalseboolean
hideOnDesktopbooleanbooleanfalseboolean

Box Default

js
const default = {
  eid: "example",
  type: "box",
  style: {
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		borderRadius: "0px",
		borderLeftColor: "#121212",
		borderLeftStyle: "solid",
		borderLeftWidth: "0px",
		borderBottomColor: "#121212",
		borderBottomStyle: "solid",
		borderBottomWidth: "0px",
		borderRightColor: "#121212",
		borderRightStyle: "solid",
		borderRightWidth: "0px",
		borderTopColor: "#121212",
		borderTopStyle: "solid",
		borderTopWidth: "0px",
		marginLeft: "0px",
		marginBottom: "0px",
		marginRight: "0px",
		marginTop: "0px",
		paddingLeft: "0px",
		paddingBottom: "0px",
		paddingRight: "0px",
		paddingTop: "0px",
  },
  attrs: {
    hideOnMobile: false,
		hideOnDesktop: false,
  },
  children: [],
  customData: {},
}

Multicolumn

Multicolumn Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "multicolumn"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
childrenarrayarray of objectsarray of elements, only column is acceptable
customDataobjectobjectany information that is not provided by our json

Multicolumn Style

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"

Multicolumn Attrs

PropertyTypeValuesDefaultAcceptable values
hideOnMobilebooleanbooleanfalseboolean
hideOnDesktopbooleanbooleanfalseboolean
stackingstringstring"left-on-top""left-on-top", "none", "right-on-top"
spacerBeforestringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
spacerBetweenstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
spacerAfterstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
spacerBeforeMobilestringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
spacerBetweenMobilestringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
spacerAfterMobilestringinteger with px postfix"0px"any integer with px postfix that follows the format 1px

Multicolumn Default

js
const default = {
  eid: "example",
  type: "multicolumn",
  style: {
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
  },
  attrs: {
    hideOnMobile: false,
		hideOnDesktop: false,
		stacking: "left-on-top",
		spacerBefore: "0px",
		spacerBetween: "0px",
		spacerAfter: "0px",
		spacerBeforeMobile: "0px",
		spacerBetweenMobile: "0px",
		spacerAfterMobile: "0px",
  },
  children: [],
  customData: {},
}

Column

Column Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "column"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
childrenarrayarray of objectsarray of elements, except fullwidth, block-level-conditional, block-level-loop, body, column, branch
customDataobjectobjectany information that is not provided by our json

Column Style

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
widthstringinteger with px postfix"300px"any integer with px postfix that follows the format 1px

Column Attrs

PropertyTypeValuesDefaultAcceptable values
hideOnMobilebooleanbooleanfalseboolean
lockstring or booleanstring or booleanfalse"all", "design", true, false

Column Default

js
const default = {
  eid: "example",
  type: "column",
  style: {
    width: "300px",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
  },
  attrs: {
    hideOnMobile: false,
		lock: false,
  },
  children: [],
  customData: {},
}

Loop

Loop Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "loop"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
childrenarrayarray of objectsarray of elements, except fullwidth, block-level-conditional, block-level-loop, body, column, branch
customDataobjectobjectany information that is not provided by our json

Loop Style

Currently not in use.

Loop Attrs

PropertyTypeValuesDefaultAcceptable values
expressionstringstring"dummy_expression"any string

Loop Default

js
const default = {
  eid: "example",
  type: "loop",
  style: {},
  attrs: {
    expression: "dummy_expression",
  },
  children: [],
  customData: {},
}

Conditional

Conditional Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "conditional"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
childrenarrayarray of objectsarray of elements, only branch
customDataobjectobjectany information that is not provided by our json

Conditional Style

Currently not in use.

Conditional Attrs

Currently not in use.

Conditional Default

js
const default = {
  eid: "example",
  type: "conditional",
  style: {},
  attrs: {},
  children: [],
  customData: {},
}

Block Level Loop

Block Level Loop Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "block-level-loop"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
childrenarrayarray of objectsarray of elements, except block-level-conditional, block-level-loop, body, column, branch
customDataobjectobjectany information that is not provided by our json

Block Level Loop Style

Currently not in use.

Block Level Loop Attrs

PropertyTypeValuesDefaultAcceptable values
expressionstringstring"dummy_expression"any string
lockstring or booleanstring or booleanfalse"all", "design", true, false

Block Level Loop Default

js
const default = {
  eid: "example",
  type: "block-level-loop",
  style: {},
  attrs: {
    lock: false,
		expression: "dummy_expression",
  },
  children: [],
  customData: {},
}

Block Level Conditional

Block Level Conditional Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "block-level-conditional"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
childrenarrayarray of objectsarray of elements, only branch
customDataobjectobjectany information that is not provided by our json

Block Level Conditional Style

Currently not in use.

Block Level Conditional Attrs

PropertyTypeValuesDefaultAcceptable values
lockstring or booleanstring or booleanfalse"all", "design", true, false

Block Level Conditional Default

js
const default = {
  eid: "example",
  type: "block-level-conditional",
  style: {},
  attrs: {
    lock: false,
  },
  children: [],
  customData: {},
}

Branch

Branch Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "branch"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
childrenarrayarray of objectsarray of elements, except fullwidth, block-level-conditional, block-level-loop, body, column, branch
customDataobjectobjectany information that is not provided by our json

Branch Style

Currently not in use.

Branch Attrs

PropertyTypeValuesDefaultAcceptable values
expressionstringstring"dummy_expression"any string
typestringstring"if""if", "else-if", "else"

Branch Default

js
const default = {
  eid: "example",
  type: "branch",
  style: {},
  attrs: {
    expression: "dummy_expression",
		type: "if",
  },
  children: [],
  customData: {},
}

Button

Button Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "button"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
customDataobjectobjectany information that is not provided by our json

Button Style

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent""#0094c5"any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
borderRadiusstringinteger with px postfix"5px"any integer with px postfix that follows the format 1px
borderLeftColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderLeftStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderLeftWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderBottomColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderBottomStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderBottomWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderRightColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderRightStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderRightWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderTopColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderTopStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderTopWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginLeftstringinteger with px postfix"20px"any integer with px postfix that follows the format 1px
marginBottomstringinteger with px postfix"20px"any integer with px postfix that follows the format 1px
marginRightstringinteger with px postfix"20px"any integer with px postfix that follows the format 1px
marginTopstringinteger with px postfix"20px"any integer with px postfix that follows the format 1px
paddingLeftstringinteger with px postfix"15px"any integer with px postfix that follows the format 1px
paddingBottomstringinteger with px postfix"15px"any integer with px postfix that follows the format 1px
paddingRightstringinteger with px postfix"15px"any integer with px postfix that follows the format 1px
paddingTopstringinteger with px postfix"15px"any integer with px postfix that follows the format 1px
lineHeightstringinteger with px postfix"25px"any integer with px postfix that follows the format 1px
colorstring, objectHEX color, color variable, "transparent""#ffffff"any HEX color that follows the format #ABABAB, "transparent", Color variable
fontSizestringinteger with px postfix"18px"any integer with px postfix that follows the format 1px
fontFamilystring, objectstring, font stack variable"Arial, Helvetica Neue, Helvetica, sans-serif"any font stack, Font stack variable
letterSpacingstringinteger with px postfix"normal"any integer with em postfix that follows the format 1.00em, "normal"
hoverBackgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
sizeTypestringstring"FIT_TO_TEXT""FIXED", "FIT_TO_TEXT"
fullWidthOnMobilebooleanbooleantrueboolean
alignstringstring"center""center", "left", "right"
boldbooleanbooleanfalseboolean
italicbooleanbooleanfalseboolean
underlinebooleanbooleanfalseboolean
widthstring, nullstring, nullnullany integer with px postfix that follows the format 1px

Button Attrs

PropertyTypeValuesDefaultAcceptable values
titlestring, objectstring, text variable""any string, Text variable
textstring, objectstring, text variable"

Click here to edit me

"
any HTML formatted string, Text variable
hrefstring, objectURL, link variable""any URL, Link variable

Box Default

js
const default = {
  eid: "example",
  type: "button",
  style: {
		lineHeight: "25px",
		color: "#ffffff",
		fontSize: "18px",
		fontFamily: "Arial, Helvetica Neue, Helvetica, sans-serif",
		letterSpacing: "normal",
		backgroundColor: "#0094c5",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		borderRadius: "5px",
		borderLeftColor: "#121212",
		borderLeftStyle: "solid",
		borderLeftWidth: "0px",
		borderBottomColor: "#121212",
		borderBottomStyle: "solid",
		borderBottomWidth: "0px",
		borderRightColor: "#121212",
		borderRightStyle: "solid",
		borderRightWidth: "0px",
		borderTopColor: "#121212",
		borderTopStyle: "solid",
		borderTopWidth: "0px",
		marginLeft: "20px",
		marginBottom: "20px",
		marginRight: "20px",
		marginTop: "20px",
		paddingLeft: "15px",
		paddingBottom: "15px",
		paddingRight: "15px",
		paddingTop: "15px",
		hoverBackgroundColor: "",
		sizeType: "FIT_TO_TEXT",
		fullWidthOnMobile: true,
		align: "center",
		bold: false,
		italic: false,
		underline: false,
    width: null
  },
  attrs: {
		title: "",
		text: "<p>Click here to edit me</p>",
		href: "",
  },
  customData: {},
}

Text

Text Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "text"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
customDataobjectobjectany information that is not provided by our json

Text Style

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
paddingLeftstringinteger with px postfix"10px"any integer with px postfix that follows the format 1px
paddingBottomstringinteger with px postfix"5px"any integer with px postfix that follows the format 1px
paddingRightstringinteger with px postfix"10px"any integer with px postfix that follows the format 1px
paddingTopstringinteger with px postfix"5px"any integer with px postfix that follows the format 1px
paragraphLineHeightstringinteger with px postfix"25px"any integer with px postfix that follows the format 1px
paragraphColorstring, objectHEX color, color variable, "transparent""#131313"any HEX color that follows the format #ABABAB, "transparent", Color variable
paragraphFontSizestringinteger with px postfix"18px"any integer with px postfix that follows the format 1px
paragraphFontFamilystring, objectstring, font stack variable"Arial, Helvetica Neue, Helvetica, sans-serif"any font stack, Font stack variable
paragraphLetterSpacingstringinteger with px postfix"normal"any integer with em postfix that follows the format 1.00em, "normal"
h1LineHeightstringinteger with px postfix"40px"any integer with px postfix that follows the format 1px
h1Colorstring, objectHEX color, color variable, "transparent""#131313"any HEX color that follows the format #ABABAB, "transparent", Color variable
h1FontSizestringinteger with px postfix"33px"any integer with px postfix that follows the format 1px
h1FontFamilystring, objectstring, font stack variable"Georgia, Times, Times New Roman, serif"any font stack, Font stack variable
h1LetterSpacingstringinteger with px postfix"normal"any integer with em postfix that follows the format 1.00em, "normal"
h2LineHeightstringinteger with px postfix"34px"any integer with px postfix that follows the format 1px
h2Colorstring, objectHEX color, color variable, "transparent""#131313"any HEX color that follows the format #ABABAB, "transparent", Color variable
h2FontSizestringinteger with px postfix"26px"any integer with px postfix that follows the format 1px
h2FontFamilystring, objectstring, font stack variable"Georgia, Times, Times New Roman, serif"any font stack, Font stack variable
h2LetterSpacingstringinteger with px postfix"normal"any integer with em postfix that follows the format 1.00em, "normal"
h3LineHeightstringinteger with px postfix"27px"any integer with px postfix that follows the format 1px
h3Colorstring, objectHEX color, color variable, "transparent""#131313"any HEX color that follows the format #ABABAB, "transparent", Color variable
h3FontSizestringinteger with px postfix"22px"any integer with px postfix that follows the format 1px
h3FontFamilystring, objectstring, font stack variable"Georgia, Times, Times New Roman, serif"any font stack, Font stack variable
h3LetterSpacingstringinteger with px postfix"normal"any integer with em postfix that follows the format 1.00em, "normal"
linkTextDecorationstringstring"underline""underline", "none"
linkColorstring, objectHEX color, color variable, "transparent""#00c0e7"any HEX color that follows the format #ABABAB, "transparent", Color variable

Text Attrs

PropertyTypeValuesDefaultAcceptable values
textstring, objectstring, text variable

Double click to edit text!

"
any HTML formatted string, Text variable

Text Default

js
const default = {
  eid: "example",
  type: "text",
  style: {
    backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		paddingLeft: "10px",
		paddingBottom: "5px",
		paddingRight: "10px",
		paddingTop: "5px",
		paragraphLineHeight: "25px",
		paragraphLetterSpacing: "normal",
		paragraphColor: "#131313",
		paragraphFontSize: "18px",
		paragraphFontFamily: "Arial, Helvetica Neue, Helvetica, sans-serif",
		linkTextDecoration: "underline",
		linkColor: "#00c0e7",
		h3LineHeight: "27px",
		h3Color: "#131313",
		h3FontSize: "22px",
		h3FontFamily: "Georgia, Times, Times New Roman, serif",
		h3LetterSpacing: "normal",
		h2LineHeight: "34px",
		h2Color: "#131313",
		h2FontSize: "26px",
		h2FontFamily: "Georgia, Times, Times New Roman, serif",
		h2LetterSpacing: "normal",
		h1LineHeight: "40px",
		h1Color: "#131313",
		h1FontSize: "33px",
		h1FontFamily: "Georgia, Times, Times New Roman, serif",
		h1LetterSpacing: "normal",
  },
  attrs: {
    text: "<p>Double click to edit text!</p>",
  },
  customData: {},
}

Typed Text

Typed Text Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "typed-text"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
customDataobjectobjectany information that is not provided by our json

Typed Text Style

Can be replaced with a component. See Typed Text component.

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
paddingLeftstringinteger with px postfix"10px"any integer with px postfix that follows the format 1px
paddingBottomstringinteger with px postfix"5px"any integer with px postfix that follows the format 1px
paddingRightstringinteger with px postfix"10px"any integer with px postfix that follows the format 1px
paddingTopstringinteger with px postfix"5px"any integer with px postfix that follows the format 1px
lineHeightstringinteger with px postfix"25px"any integer with px postfix that follows the format 1px
colorstring, objectHEX color, color variable, "transparent""#131313"any HEX color that follows the format #ABABAB, "transparent", Color variable
fontSizestringinteger with px postfix"18px"any integer with px postfix that follows the format 1px
fontFamilystring, objectstring, font stack variable"Arial, Helvetica Neue, Helvetica, sans-serif"any font stack, Font stack variable
letterSpacingstringinteger with px postfix"normal"any integer with em postfix that follows the format 1.00em, "normal"
linkTextDecorationstringstring"underline""underline", "none"
linkColorstring, objectHEX color, color variable, "transparent""#00c0e7"any HEX color that follows the format #ABABAB, "transparent", Color variable
subTypestringstring"paragraph""paragraph", "heading1", "heading2", "heading3", "list"
listMarkerTypestringstring"disc""disc", "square", "decimal", "lower-roman", "upper-roman", "lower-alpha", "upper-alpha"
listMarkerFontSizestringinteger with px postfix"18px"any integer with px postfix that follows the format 1px
listMarkerColorstring, objectHEX color, color variable, "transparent""#131313"any HEX color that follows the format #ABABAB, "transparent", Color variable
listMarkerFontFamilystring, objectstring, font stack variable"Arial, Helvetica Neue, Helvetica, sans-serif"any font stack, Font stack variable
lineSpacingstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
alignstringstring"center""center", "left", "right", "justify"
boldbooleanbooleanfalseboolean
italicbooleanbooleanfalseboolean
underlinebooleanbooleanfalseboolean

Typed Text Attrs

PropertyTypeValuesDefaultAcceptable values
textstring, objectstring, text variable"Double click to edit text!"any text string, Text variable

Typed Text Default

js
const default = {
  eid: "example",
  type: "typed-text",
  style: {
		subType: "paragraph",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		paddingLeft: "10px",
		paddingBottom: "5px",
		paddingRight: "10px",
		paddingTop: "5px",
		lineHeight: "25px",
		letterSpacing: "normal",
		color: "#131313",
		fontSize: "18px",
		fontFamily: "Arial, Helvetica Neue, Helvetica, sans-serif",
		linkTextDecoration: "underline",
		linkColor: "#00c0e7",
		listMarkerType: "disc",
		listMarkerFontSize: "18px",
		listMarkerColor: "#131313",
		listMarkerFontFamily: "Arial, Helvetica Neue, Helvetica, sans-serif",
		lineSpacing: "0px",
		align: "left",
		bold: false,
		italic: false,
		underline: false,
  },
  attrs: {
    text: "Double click to edit text!",
  },
  customData: {},
}

Divider

Divider Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "divider"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
customDataobjectobjectany information that is not provided by our json

Divider Style

Can be replaced with a component. See Divider component.

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
paddingLeftstringinteger with px postfix"10px"any integer with px postfix that follows the format 1px
paddingBottomstringinteger with px postfix"10px"any integer with px postfix that follows the format 1px
paddingRightstringinteger with px postfix"10px"any integer with px postfix that follows the format 1px
paddingTopstringinteger with px postfix"10px"any integer with px postfix that follows the format 1px
widthstringinteger with px postfix"2px"any integer with px postfix that follows the format 1px
typestringstring"solid""solid", "double", "dashed", "dotted"
colorstring, objectHEX color, color variable, "transparent""#a9a9a9"any HEX color that follows the format #ABABAB, "transparent", Color variable
alignstringstring"center""center", "left", "right", "justify"

Divider Attrs

Currently not in use.

Divider Default

js
const default = {
  eid: "example",
  type: "divider",
  style: {
		width: "2px",
		type: "solid",
		color: "#a9a9a9",
		align: "center",
		backgroundColor: "",
		backgroundPosition: "center center",
		backgroundRepeat: "no-repeat",
		backgroundImage: "",
		backgroundSize: "auto",
		paddingTop: "10px",
		paddingRight: "10px",
		paddingBottom: "10px",
		paddingLeft: "10px",
  },
  attrs: {},
  customData: {},
}

Image

Image Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "image"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
customDataobjectobjectany information that is not provided by our json

Image Style

Can be replaced with a component. See Image component.

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
borderRadiusstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderLeftColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderLeftStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderLeftWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderBottomColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderBottomStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderBottomWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderRightColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderRightStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderRightWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderTopColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderTopStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderTopWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginLeftstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginBottomstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginRightstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginTopstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingLeftstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingBottomstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingRightstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingTopstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
fullWidthOnMobilebooleanbooleanfalseboolean
alignstringstring"center""center", "left", "right"
lockedWidthstring, nullstring, nullnullany integer with px postfix that follows the format 1px, null
lockedHeightstring, nullstring, nullnullany integer with px postfix that follows the format 1px, null
maxHeightstringinteger with px postfix"300px"any integer with px postfix that follows the format 1px
maxWidthstringinteger with px postfix"300px"any integer with px postfix that follows the format 1px
widthstringinteger with px postfix"150px"any integer with px postfix that follows the format 1px

Image Attrs

PropertyTypeValuesDefaultAcceptable values
titlestring, objectstring, text variable""any string, Text variable
linkstring, objectURL, link variable""any URL, Link variable
altTextstring, objectstring, text variable""any string, Text variable
srcstring, objectURL, image variable"https://cdn.chamaileon.io/assets/img/image_placeholder.png"any image URL, Image variable

Image Default

js
const default = {
  eid: "example",
  type: "image",
  style: {
    fullWidthOnMobile: false,
		align: "center",
		lockedWidth: null,
		lockedHeight: null,
		maxHeight: "300px",
		maxWidth: "300px",
		width: "150px",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		borderRadius: "0px",
		borderLeftColor: "#121212",
		borderLeftStyle: "solid",
		borderLeftWidth: "0px",
		borderBottomColor: "#121212",
		borderBottomStyle: "solid",
		borderBottomWidth: "0px",
		borderRightColor: "#121212",
		borderRightStyle: "solid",
		borderRightWidth: "0px",
		borderTopColor: "#121212",
		borderTopStyle: "solid",
		borderTopWidth: "0px",
		marginLeft: "0px",
		marginBottom: "0px",
		marginRight: "0px",
		marginTop: "0px",
		paddingLeft: "0px",
		paddingBottom: "0px",
		paddingRight: "0px",
		paddingTop: "0px",
  },
  attrs: {
    title: "",
		link: "",
		altText: "",
		src: "https://cdn.chamaileon.io/assets/img/image_placeholder.png",
  },
  customData: {},
}

Dynamic Image

Dynamic Image Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "dynamic-image"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
customDataobjectobjectany information that is not provided by our json

Dynamic Image Style

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
borderRadiusstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderLeftColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderLeftStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderLeftWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderBottomColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderBottomStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderBottomWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderRightColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderRightStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderRightWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderTopColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderTopStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderTopWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginLeftstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginBottomstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginRightstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginTopstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingLeftstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingBottomstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingRightstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingTopstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
fullWidthOnMobilebooleanbooleanfalseboolean
alignstringstring"center""center", "left", "right"
maxHeightstringinteger with px postfix"300px"any integer with px postfix that follows the format 1px
maxWidthstringinteger with px postfix"300px"any integer with px postfix that follows the format 1px
widthstringinteger with px postfix"150px"any integer with px postfix that follows the format 1px
heightstringinteger with px postfix"150px"any integer with px postfix that follows the format 1px

Dynamic Image Attrs

PropertyTypeValuesDefaultAcceptable values
titlestring, objectstring, text variable""any string, Text variable
linkstring, objectURL, link variable""any URL, Link variable
altTextstring, objectstring, text variable""any string, Text variable
srcstringURL"https://placehold.co/150x150.png"any image URL

Dynamic Image Default

js
const default = {
  eid: "example",
  type: "dynamic-image",
  style: {
		align: "center",
		fullWidthOnMobile: false,
		maxHeight: "300px",
		maxWidth: "300px",
		width: "150px",
		height: "150px",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		borderRadius: "0px",
		borderLeftColor: "#121212",
		borderLeftStyle: "solid",
		borderLeftWidth: "0px",
		borderBottomColor: "#121212",
		borderBottomStyle: "solid",
		borderBottomWidth: "0px",
		borderRightColor: "#121212",
		borderRightStyle: "solid",
		borderRightWidth: "0px",
		borderTopColor: "#121212",
		borderTopStyle: "solid",
		borderTopWidth: "0px",
		marginLeft: "0px",
		marginBottom: "0px",
		marginRight: "0px",
		marginTop: "0px",
		paddingLeft: "0px",
		paddingBottom: "0px",
		paddingRight: "0px",
		paddingTop: "0px",
  },
  attrs: {
    title: "",
		link: "",
		altText: "",
		src: "https://placehold.co/150x150.png"
  },
  customData: {},
}

Video

Video Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "video"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
customDataobjectobjectany information that is not provided by our json

Video Style

Can be replaced with a component. See Video component.

PropertyTypeValuesDefaultAcceptable values
backgroundColorstring, objectHEX color, color variable, "transparent"""any HEX color that follows the format #ABABAB, "transparent", Color variable
backgroundRepeatstringcss value"no-repeat""no-repeat", "repeat", "repeat-x", "repeat-y"
backgroundPositionstringcss value"center center""left", "center", "right", "bottom", "top", "left top", "left center", "left bottom", "center top", "center center", "center bottom", "right top", "right center", "right bottom", "top left", "top center", "top right", "bottom left", "bottom center", "bottom right"
backgroundImagestring, objectURL, image variable""any image URL, Image variable
backgroundSizestringcss value"auto""auto", "contain", "cover"
borderRadiusstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderLeftColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderLeftStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderLeftWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderBottomColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderBottomStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderBottomWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderRightColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderRightStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderRightWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
borderTopColorstring, objectHEX color, color variable, "transparent""#121212"any HEX color that follows the format #ABABAB, "transparent", Color variable
borderTopStylestringcss value"solid""double", "dotted", "dashed", "solid", "none"
borderTopWidthstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginLeftstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginBottomstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginRightstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
marginTopstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingLeftstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingBottomstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingRightstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
paddingTopstringinteger with px postfix"0px"any integer with px postfix that follows the format 1px
fullWidthOnMobilebooleanbooleanfalseboolean
alignstringstring"center""center", "left", "right"
lockedWidthstring, nullstring, nullnullany integer with px postfix that follows the format 1px, null
lockedHeightstring, nullstring, nullnullany integer with px postfix that follows the format 1px, null
maxHeightstringinteger with px postfix"338px"any integer with px postfix that follows the format 1px
maxWidthstringinteger with px postfix"600px"any integer with px postfix that follows the format 1px
widthstringinteger with px postfix"600px"any integer with px postfix that follows the format 1px
iconColorstring, objectHEX color, color variable, "transparent""#FF0000"any HEX color that follows the format #ABABAB, "transparent", Color variable
iconSizestringinteger with px postfix"50px"any integer with px postfix that follows the format 1px
iconTypestringstring"youtube""play", "play-box", "play-box-outline", "play-circle", "play-circle-outline", "youtube"

Video Attrs

PropertyTypeValuesDefaultAcceptable values
linkstring, objectURL, link variable""any URL, Link variable
altTextstring, objectstring, text variable""any string, Text variable
videoIdstringstring""any videoId from vimeo or youtube
videoProviderstringstring"""vimeo", "youtube"
previewBaseUrlstringURL""Video element backend base URL
thumbnailBaseUrlstringURL""Video element backend base URL
srcstringURL"https://placehold.co/600x338.png"any image URL

Video Default

js
const default = {
  eid: "example",
  type: "video",
  style: {
		align: "center",
		iconColor: "#FF0000",
		iconSize: "50px",
		iconType: "youtube",
		lockedWidth: null,
		lockedHeight: null,
		maxHeight: "338px",
		maxWidth: "600px",
		width: "600px",
		backgroundColor: "",
		backgroundRepeat: "no-repeat",
		backgroundPosition: "center center",
		backgroundImage: "",
		backgroundSize: "auto",
		borderRadius: "0px",
		borderLeftColor: "#121212",
		borderLeftStyle: "solid",
		borderLeftWidth: "0px",
		borderBottomColor: "#121212",
		borderBottomStyle: "solid",
		borderBottomWidth: "0px",
		borderRightColor: "#121212",
		borderRightStyle: "solid",
		borderRightWidth: "0px",
		borderTopColor: "#121212",
		borderTopStyle: "solid",
		borderTopWidth: "0px",
		marginLeft: "0px",
		marginBottom: "0px",
		marginRight: "0px",
		marginTop: "0px",
		paddingLeft: "0px",
		paddingBottom: "0px",
		paddingRight: "0px",
		paddingTop: "0px",
  },
  attrs: {
    link: "",
		altText: "",
		videoId: "",
		videoProvider: "",
		previewBaseUrl: "",
		thumbnailBaseUrl: "",
		src: "https://placehold.co/600x338.png",
  },
  customData: {},
}

Code

Code Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "code"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
customDataobjectobjectany information that is not provided by our json
placeholderobjectobjectelement, except fullwidth, block-level-conditional, block-level-loop, body, column, branch. This is used to show different content inside the editor that hides the actual content

Code Style

Currently not in use.

Code Attrs

PropertyTypeValuesDefaultAcceptable values
titlestringstring"Your title"any string
contentstringstring""any HTML string
stylestringstring""any AMP supported css
isAmpbooleanbooleanfalseboolean

Code Default

js
const default = {
  eid: "example",
  type: "code",
  style: {},
  attrs: {
    title: "Your title",
		content: "<your-code></your-code>",
		style: "",
		isAmp: false,
  },
  placeholder: {},
  customData: {},
}

Social

Social Properties

PropertyTypeValuesDescription
eidstringstringhas to be unique within the full JSON, cannot be "root"
typestringstringelement type, has to be "social"
styleobjectRead moresee style properties of this element
attrsobjectRead moresee attr properties of this element
customDataobjectobjectany information that is not provided by our json

Social Style

Currently not in use.

Social Attrs

PropertyTypeValuesDefaultAcceptable values
elementsarrayobject{}any element object that contains the 3 parameters that are detailed below
elements.typestringstring"""Blogger", "Facebook", "Instagram", "Linkedin", "Medium", "Pinterest", "Snapchat", "SoundCloud", "Spotify", "Telegram", "TikTok", "Tumblr", "Twitter", "Vimeo", "Vkontakte", "WeChat", "YouTube"
elements.linkstringURL""any URL
elements.srcstringstring""any string that targets the icon without the base URL
alignstringstring"center""center", "left", "right"
colorstringstring"colorful""colorful", "black", "grey", "white"
iconSetnumberinteger between 1 and 541 (flat), 2 (square), 3 (roundedSquare), 4 (circle), 5 (transparentCircle)
sizenumberany integer40any integer
layoutstringstring"horizontal""horizontal", "vertical"
spacingnumberany integer10any integer
hideOnMobilebooleanbooleanfalseboolean
hideOnDesktopbooleanbooleanfalseboolean
reorderOnMobilebooleanbooleanfalseboolean
baseUrlstringURL"https://cdn.chamaileon.io/assets/"any URL that targets the CDN where you store your social icons

Social Default

js
const default = {
  eid: "example",
  type: "social",
  style: {},
  attrs: {
    elements: [
			{
				type: "Facebook",
				link: "https://www.facebook.com/",
				src: "img/Facebook/fb-4-colorful.png",
			},
			{
				type: "Linkedin",
				link: "https://www.linkedin.com/",
				src: "img/Linkedin/li-4-colorful.png",
			},
			{
				type: "Instagram",
				link: "https://www.instagram.com/",
				src: "img/Instagram/ig-4-colorful.png",
			},
			{
				type: "Twitter",
				link: "https://www.twitter.com/",
				src: "img/Twitter/tw-4-colorful.png",
			},
		],
		align: "center",
		color: "colorful",
		iconSet: 4,
		size: 40,
		layout: "horizontal",
		spacing: 10,
		hideOnMobile: false,
		hideOnDesktop: false,
		reorderOnMobile: false,
		baseUrl: "https://cdn.chamaileon.io/assets/",
  },
  customData: {},
}

Changelog

4.1.0

Added

  • bold, italic and underline properties to button style
  • bold, italic and underline properties to typed-text style
  • validation and conversion tools for customData.externalElementDefaultJson that is used with the new externalElements feature (more details in the Editor External elements section)

4.0.0 or older

  • This is the starting point of the documentation