📙
Documentation
🗃️

Block Attributes

NameTypeDescriptionCommon to All
String
The cover image that you would want to set as default for the block. Eg: “https://files-myxp.s3-ap-southeast-1.amazonaws.com/livestream/default_background/Light_BG_1.png”
Yes
Boolean
Does not allow popup to occur when this field is true.
Yes
Object
Refer here.
Yes
Boolean
Only render background image when this field is true.
Yes
String
Sets the height of the block, only useful when fitHeightToContent is false. Eg: “200px”, “2rem”Units can be: px, em, rem, %.
Yes
Boolean
Determines if the block visibility should be rendered by default.
Yes
String
Only needs to be specified when widthType is “custom”. Eg: “100%”Units can be: px, em, rem, %.
Yes
Boolean
Value of true would result in the block being wrapped with a white background.
Yes
Object
Refer here.
Yes
String
“338px” Width to height ratio must be at least 1:1.3 Units can be: px, em, rem, %.
No
String
“2px” Units can be: px, em, rem, %.
No
String
260px Units can be: px, em, rem, %.
No
Array
[“0”, “0”, “0”, “0”, “px”]Last index can be: “px”, “rem”, “em”, “%”, “”.
Yes
String
[“0”, “0”, “0”, “0”, “px”] Last index can be: “px”, “rem”, “em”, “%”, “”.
Yes
Boolean
Setting this field to true would result in blockHeight to have a predetermined value.
Yes
String
“heading”
Yes
Enum
"center" | "left"
Yes
Boolean
true
Yes
Enum
“inline” | “grid”
No
Integer
1
Yes
Enum
“all” | “filtered” | “list”
No
Enum
“firstname” | “lastname” | “jobTitle” | “company”
No
Enum
“ASC” | “DESC”
No
Boolean
true
No
Boolean
true
No
Boolean
true
No
String
”[]” Must be a string of Array
No
Enum
Renders the block width styling based on the value selected. Only when “custom” is selected, blockWidth needs to be specified. Eg: “full” | “half” | “custom” | “fit-content”
Yes