🗃️

Block Attributes

Name
Type
Description
Common to All
backgroundCoverImage
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
backgroundCoverImageDisablePopup
Boolean

Does not allow popup to occur when this field is true.

Yes
backgroundCoverImageDistortion
Object

Refer here.

Yes
backgroundCoverImageVisibility
Boolean

Only render background image when this field is true.

Yes
blockHeight
String

Sets the height of the block, only useful when fitHeightToContent is false. Eg: “200px”, “2rem”Units can be: px, em, rem, %.

Yes
blockVisibility
Boolean

Determines if the block visibility should be rendered by default.

Yes
blockWidth
String

Only needs to be specified when widthType is “custom”. Eg: “100%”Units can be: px, em, rem, %.

Yes
boundingBox
Boolean

Value of true would result in the block being wrapped with a white background.

Yes
breakpoints
Object

Refer here.

Yes
contentMargin
Array

[“0”, “0”, “0”, “0”, “px”]Last index can be: “px”, “rem”, “em”, “%”, “”.

Yes
contentPadding
String

[“0”, “0”, “0”, “0”, “px”] Last index can be: “px”, “rem”, “em”, “%”, “”.

Yes
fitHeightToContent
Boolean

Setting this field to true would result in blockHeight to have a predetermined value.

Yes
heading
String

“heading”

Yes
headingAlignment
Enum

"center" | "left"

Yes
headingVisibility
Boolean

true

Yes
images
Array

Refer here.

No
order
Integer

1

Yes
spaceBetweenImages
String

“0px”. Units can be: px, em, rem, %.

No
widthType
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