Skip to content

Instantly share code, notes, and snippets.

@owain-stratton
Last active July 31, 2017 13:38
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save owain-stratton/8bba089e97293b8873a20a5c7b99b869 to your computer and use it in GitHub Desktop.
Save owain-stratton/8bba089e97293b8873a20a5c7b99b869 to your computer and use it in GitHub Desktop.
Carousel Widget Readme

funstage-carousel-widget

Description of funstage-carousel-widget

Configuration:

Arguments and default values:

{
   "args": {
      "crmUrl": null,
      "parameters": {
         "playerId": null,
         "platformID": "gaminator",
         "langID": "EN",
      },
      "crmUrlHash": null,
      "redirectBaseUrl": null,
      "carousel": true,
      "placeholderFilter": null
   }
}

Argument Parameters

Property Type Description Default Value
crmUrl String URL to get CRM data, should not include URL parameters null
parameters Object Object with string values that represent URL parameters to append to the crmUrl. The playerID, platformID and langID parameters are required. { "playerId": null, "platformID": "gaminator", "langID": "EN" }
crmUrlHash String Optional, hash (#) to added at the end of the URL null
redirectBaseUrl String Required, if provided will be used as the base url when the user clicks in one of the banners. Only useful if the CRM provides relative paths null
carousel Boolean If true the widget is a carousel, else false means it is a X-SELL widget true
placeholderFilter String This is used to filter the response from the CRM to return only the banner campaign relevant for the location null

CRM Response

The carousel widget uses the following property: value pairs from the CRM response.

Property Description
bannerURL1 Return the background image
actionURL Provide redirect action
textLine1 Provides title for banner
textLine2 Provides sub-text for banner
textLine3 Provides button text for banner
bannerPlaceholders Used to filter the CRM response to return relevant banner campaigns

Notes

Carousel widget shows all the images provided by the CRM. Alongside the text provided as well as a button that when clicked opens a new tab with the URL provided by the CRM. The information is shown in a carousel. If any data is empty it won't be shown (button, texts)

X-SELL widget same as the carousel but no text or button is shown. Instead of clicking any part of the image to open the new page, the user need to click the button

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment