Link

Link

Type Name
Link
Usage
The link block can have a cover image which links to a URL
Icon
Screenshots
Type
Content
Content Category
Custom

About the Link

The Link block is used to display a cover image which links to a URL.

Create a Link Block

To create a Link block, in the Venue Editor, click on "Add Blocks" button in the settings panel on the left, then choose "Link" under the Custom category.

image

Block Settings

The main setting of the Link block is Covered Image and Link where you can insert the image and the URL.

image

JSON Config

Attributes

🗃️
Block Attributes

NameTypeDescriptionCommon 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
enableLink
Boolean
true
No
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
link
String
“https://www.gevme.com/page/…”
No
openInNewWindow
Boolean
true
No
order
Integer
1
Yes
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

Sample

"link-block": {
  "type": "Link",
  "title": "Lounge",
  "data": {
      "heading": "Lounge",
      "title": "Lounge",
      "headingVisibility": false,
      "headingAlignment": "center",
      "backgroundCoverImage": "https://venues-sdk-dev.gevme.com/assets/venue-genesis/serendipity-lounge.png",
      "backgroundCoverImageVisibility": true,
      "enableLink": true,
      "link": "lounge",
      "openInNewWindow": false,
      "order": 3,
      "alignment": "left",
      "blockWidth": "50%",
      "blockHeight": "297px",
      "widthType": "half",
      "fitHeightToContent": false,
      "boundingBox": true,
      "contentPadding": ["0", "0", "0", "0", "px"],
      "contentMargin": ["48", "0", "0", "0", "px"]
  }
}