📙
Documentation
Hero Content (Developer)

Hero Content (Developer)

Type Name
HeroContent
Usage
This block is useful for displaying key content prominently.
Icon
Screenshots
Type
Content
Content Category
Event Information

About the Hero Content

The Hero Content is used to show your key content prominently.

Creating a Hero Content Block

To create a Hero Content block, in the Venue Editor, click on "Add Blocks" button in the settings panel on the left, then choose "Hero Content" under the Event Information category.

image

Block Settings

The main setting of the Hero Content block is the Card Display where you can insert a static image.

In addition, you can utilise all the space to meet your objective

  • Heading
  • Title
  • Description
  • Link

image

JSON Config

Attributes

🗃️
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
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
String
“image”
No
String
“https://files-myxp.gevme.com/…”
No
String
””
No
String
“description”
No
Boolean
true
No
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
String
“https://www.gevme.com/page/…”
No
Integer
1
Yes
String
“title”
No
Boolean
true
No
Enum
“HeroContent” | "FeaturedContent"
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

Sample

"hero-block": {
  "type": "HeroContent",
  "title": "Hero Content",
  "data": {
      "heading": "Hero Content",
      "title": "Hero Content",
      "headingVisibility": false,
      "headingAlignment": "center",
      "Description": "Use the hero content block to show some key content prominently. This could be a banner leading to your main session for example.",
      "DescriptionVisibility": true,
      "titleVisibility": true,
      "coverDisplayType": "video",
      "coverImage": "",
      "coverLivestreamOrVideo": null,
      "link": null,
      "openInNewWindow": true,
      "order": 4,
      "alignment": "left",
      "blockWidth": "100%",
      "blockHeight": "fit-content",
      "widthType": "full",
      "fitHeightToContent": true,
      "boundingBox": true,
      "contentPadding": ["16", "16", "16", "16", "px"],
      "contentMargin": ["40", "0", "0", "0", "px"]
  }
}