CMS
Banners
FunnelBlock

FunnelBlock

A FunnelBlock is a full screen sized banner with most of the time an ImageBlock as background. The FunnelBlock persists of that said background, which often stretches across the whole screen. On the banner itself can a title, short text and a button be found if added to it.

Structure example

Take a look at the example, to further understand the possibilities, of how a FunnelBlock can be structured.


Funnel block example.

This example shows a funnel banner that is always stretched to 100% view height.

{
   "requiredDisplayTitle":{
      "content":"FBB screen height",
      "size":"xl3",
      "weight":"black",
      "classification":"sans"
   },
   "displayDescription":{
      "content":"desc",
      "size":"lg",
      "weight":"semibold",
      "classification":"sans"
   },
   "buttons":[
      {
         "url":"https://www.shophub.de",
         "text":"shophub"
      }
   ],
   "background":{
      "__typename":"ImageBlock",
      "id":"my-image-block-id"
   },
   "styleOptions":{
      "isScreenHeight":true
   }
}

Create

POST _apiBaseUrl/v1/cms/banner/funnel-block

Code

FunnelBlockBannerDto
{
   "requiredDisplayTitle":{
      "content":"FBB screen height",
      "size":"xl3",
      "weight":"black",
      "classification":"sans"
   },
   "displayDescription":{
      "content":"desc",
      "size":"lg",
      "weight":"semibold",
      "classification":"sans"
   },
   "buttons":[
      {
         "url":"https://www.shophub.de",
         "text":"shophub"
      }
   ],
   "background":{
      "__typename":"ImageBlock",
      "id":"my-image-block-id"
   },
   "styleOptions":{
      "alignment": "center",
      "minHeight": null,
      "maxHeight": null,
      "isScreenHeight":true
   }
}

Arguments

requiredDisplayTitlerequired

A required display title.

displayDescription
null

An optional description, rendered below the required title.

buttons

An optional array of buttons, that are rendered next to each below the title and description of the banner.

An optional background in the form as a loosely connected ImageBanner entity, that is placed behind the banner as background.

styleOptions

Optional style options to further customize the funnel block.

FunnelBlockStyleOptionsDto
alignment

Defines where the title, description and buttons will be aligned on the banner canvas.

minHeight
string|
null

Defines the min height of the funnel block. Can be any CSS width value type. Highly recommended to be a static value like pixels.

isScreenHeight
boolean|
null

Sets the banner to the clients screen height if set to true.