Common properties quickstart
PreviousCreate, edit, or remove component propertiesNextCreate, edit, or delete a Presentation Template
Last updated
Last updated
The guide below outlines the common properties of some common components. Each heading denotes a component and defines that component's properties.
Presentation PropertiesProperty Name
Description
DefaultZipCode
The postal code the Presentation defaults to.
DefaultOfferGroupId
The Offer Group ID the Presentation defaults to.
Theme
Enables clients to configure paddings, stylings, borders etc. to match the. Some of the Themes are custom and are designed for a specific clients.
InputPadding
The padding distance for all input fields in a Presentation.
StepPadding
The padding distance for all steps in a Presentation.
HeaderProperty Name
Description
StylingBackgroundColor
Color of the Header background
StylingBorderColor
Color of the Header border
StylingTextColor
Color of the Header text
BackText
Text of the ‘Back’ navigation button
LoginSectionShow
If the toggle is on then the Login section is shown at the Header, otherwise is hidden
LoginText
Log in control text
LogoutText
Log out control text
LogoUrl
Makes the Logo clickable; click on the Logo redirects the user to the URL specified
LogoAltText
Alternate Logo text shown on hover
StylingBackgroundImage
Image that can be set as the Header background
StylingLogoAlignLeft
If the toggle is on then the Logo is aligned to the left, otherwise is centered
AlreadySubscriber Show
If the toggle is on then the option for subscribers to view the offers is displayed is aligned to the left, otherwise is hidden
AlreadySubscriber Title
The text shown for subscribers in case 'AlreadySubscriber Show' toggle is set to on
AlreadySubscriber LinkText
The text of the link for the subscribers
AlreadySubscriber Url
The URL redirecting subscribers to view the offers
Landing TilesProperty Name
Description
SubtypeName
Applies additional styling to a way that the Landing Tiles are displayed, i.e. Rounded, NoImage
DisplayInlineCount
Specifies how many promotions should be displayed inline
Title
The text of the title displayed at the top of the landing; formatted text
Subtitle
The text of the subtitle displayed at the top of the landing but beneath the title; formatted text
IncreaseTileOnHover
If the toggle is on then the promotion that is currently on hover will be displayed with bigger size
SliderDotsColor
The color of the navigation controls that allow to navigate within the promotions
PageProperty Name
Description
DisplayType
This property defines how the component should behave when appeared
Title
The Title of the Page; formatted text
Subtitle
The Subtitle of the Page; formatted text
Styling Background Image
The link to the background image for the Psge
Styling Background Color
The color of the Page background
Styling Background Scrollable
If the toggle is on then the background of the Page is scrollable
Styling Background AccentColor
The accent color of the Page background; if specified then the background has two colors - the main one and the accent one
Styling Background AccentImage
The accent background image; if specified then the background has two images - the main one and the accent one
AlternativeMobileStyling
If the toggle is on then the Page will look different on mobile devices. The following properties are mobile specific and are analogous to those for the desktop: MobileTitle, MobileSubtitle, MobileStyling.Background.Image, MobileStyling.Background.Color, MobileStyling.AccentColor, MobileStyling.Background.AccentImage
Offer SelectorProperty Name
Description
Offer Button Text
The text of the main Offer button
Show Offer Title?
If the toggle is on then the Title of the Offer is displayed, otherwise is hidden
Show Offer Price?
If the toggle is on then the Price of the Offer is displayed, otherwise is hidden
Show Offer Image?
If the toggle is on then the Offer image is displayed, otherwise is hidden
Show Image On Mobile Devices?
If then toggle is on then the Offer Image is displayed on mobile devices, otherwise is hidden
Title
The Title of the Offer, formatted text
Auto Select Offer
If then toggle is on then the Offer the user clicked on is autoselected, otherwise all the offers are displayed in the same way
Offer Button Position
Indicates whether the button should be aligned to the left, to the right to centered
Show Express Checkout Offer Text?
If then toggle is on then the Title of the Offer is displayed, otherwise is hidden
Show TermsAndConditions?
If then toggle is on then the Title of the Offer is displayed, otherwise is hidden
Show Body
If then toggle is on then the Title of the Offer is displayed, otherwise is hidden
Promotion Digital and Promotion ZipCodeProperty Name
Description
Title
The Title of the Promotion, formatted text
Subtitle
The Subtitle of the Promotion, shown below the Promotion Title, formatted text
Image
The Promotion image
ImageAlt
Alternate image text shown on hover
Body
The Body of the Promotion describing Promotion details shown at the bottom of the Promotion, formatted text
Button OfferGroupId
The Promotion code relevant to the main Promotion button
Button PromotionCode
The Promotion code relevant to the main Promotion button
Button Text
The text of the main Promotion button
RespectURLParams
If the toggle is ON then the flow will go according to the Presentation URL parameters specified, otherwise the URL parameters will be ignored
NoOffersAvailableMessage
Error message displayed in case there are no offers for the zipcode entered
ActionsInModal
If the toggle is ON then the promotions will be displayed in a Modal window so that user's must choose one before continuing
Suppress ZIP Validation Against Default Area?
If the toggle is on then
HideInputs
If the toggle is on then the zipcode input is hidden by default and will be shown only the button is clicked
StepProperty Name
Description
Button Text
The text of the main Step button that redirects to the next Step/Page if the current one is valid
Pricing ActivationFeeShow
If the toggle is on then the Activation Fee is shown to the user, otherwise is hidden
Pricing Amount Show
If the toggle is on then the Pricing is shown to the user, otherwise is hidden
Pricing TaxAmount Show
If the toggle is on then the Tax Amount is shown to the user, otherwise is hidden
Pricing TotalPrice Show
If the toggle is on then the Total Price is shown to the user, otherwise is hidden
Spinner Show
If the toggle is on then the Spinner will be shown while an an action is performed (typically a request to the API)
Should this step be added to Step Indicator?
If the toggle is on then the Step is be included in Step Indicator
Title
The title of the Step
Delivery Information and Billing InformationProperty Name
Description
AddressLine Placeholder
Placeholder of the AddressLine input
City Placeholder
Placeholder of the City input
FirstName Placeholder
Placeholder of the FirstName input
LastName Placeholder
Placeholder of the LastName input
PhoneNumber Placeholder
Placeholder of the PhoneNumber input
SecondAddressLine Placeholder
Placeholder of the SecondAddressLine input
State Placeholder
Placeholder of the State dropdown; if not specified then the first dropdown option will be preselected
Zipcode Placeholder
Placeholder of the Zipcode input
NotRoutable OfferGroupId
OfferGroupId offered to the user in case the delivery is not possible for the zipcode entered
NotRoutable LinkText
The text of the link that redirects user to a special offer, shown in case the delivery is not possible for the zipcode entered
NotRoutable DisclaimerText
The disclaimer text shown in case the delivery is not possible for the zipcode entered
NotRoutable NoOffersErrorMessage
The error message shown in case there are no offers for the zipcode entered
FooterProperty Name
Description
Body
Footer body, HTML-formatted fragment
StylingBackgroundColor
Color of the Footer background
StylingBorderColor
Color of the Footer border
Cookie NoticeProperty Name
Description
Cookie Text
The text of the Cookie Notice
Cookie Link
The text of the link, usually ‘Private Policy’
Cookie Link Text
The link, usually resurects user to the Private Policy details
Styling TextColor
The color of the Cookie Text and Cookie Link Text
Styling BackgroundColor
The color of the backgroung
Idle PopoverProperty Name
Description
Title
The title of the popover
Body
The main popover text
Idle Timeout
The timeout in seconds. If user stays active for the timeout specified then the Idle Popover will be displayed
Number of Openings
The number of times the popover will be displayed to the end users
Abandonment PopoverProperty Name
Description
Title
The title of the popover
Body
The main popover text
BackgroundColor
The color of the popover background
Number of Openings
The number of times the popover will be displayed to the end users
BackgroundImage
The Image set as the popover background
Registration on ConfirmationProperty Name
Description
Title
The title; usually offers user to create a password to register
SuccessMessage
success message, show in case user has been successfully registered
Order SummaryProperty Name
Description
BillingInformation.Show
Toggle; if the toggle is set to ON then Billing Information block is displayed, otherwise is hidden
DeliveryInformation.Edit
Toggle; if the toggle is set to ON then the icon allowing to edit Delivery Information is displayed, otherwise there is no icon
PaymentInformation.Show
Toggle; if the toggle is set to ON then Payment Information block is displayed, otherwise is hidden
UserInformation.Email.Show
Toggle; if the toggle is set to ON then User Email is displayed, otherwise is hidden
UserInformation.Show
Toggle; if the toggle is set to ON then User Information block is displayed
