DCOfferGridView

DCOfferGridView

c-dc-offer-grid-view is the component for offer grid view.

Constructor

new DCOfferGridView()

Properties:
Name Type Description
offers OfferObject indicates an object which contains a list of all the offers.
Example
Sample Usage -

Include the component in your template by adding c-dc-offer-grid-view custom tag

<c-dc-offer-grid-view offers={offerList}></c-dc-offer-grid-view>

| Attribute Name    | Type Expected                                                                   | Required |
|-------------------|---------------------------------------------------------------------------------|----------|
| offers            | An object which contains a list of all the offers                               | Required |


 KEY INFO -

 events fired :
               | Event Name                             | Description                                                        |
               |----------------------------------------|--------------------------------------------------------------------|
               | vlocity-dc-offer-selected              | Event triggered on selecting an offer                              |

 events registered : "none"

 Dependency - c-dc-offer-grid-view is a component used to render grid view of offer list and is commonly used as a child of c-dc-offer-list
 but can also be used as an independent component

               | Parent Component        | Expected Children Components           |
               |-------------------------|----------------------------------------|
               | c-dc-offer-list         | c-dc-offer-grid-view-image             |
               |                         | c-dc-offer-grid-view-price             |
               |                         | c-dc-offer-grid-view-attribute         |

Sample with slots -

<c-dc-offer-grid-view>
   <span slot="{slot_name}">
     Custom HTML elements goes here
   </span>
</c-dc-offer-grid-view>

List of available slots -

| Slot names                 | Dynamic     | Description                 | Impact               |
|----------------------------|-------------|----------------------------------------------------|
| dc-offer-grid-view-wrapper | -           | Wrapper for template        | Replaces DOM         |
| dc-attributes              | -           | Offer attributes            | Replaces DOM         |
| dc-offer-desc              | -           | Ofeer description           | Replaces DOM         |

Extends

Methods

(static) getSDKInstance()

Method to get digital commerce SDK instance.

(static) getTranslationLabels()

Method to get digital commerce SDK instance.

(static) selectOffer(evt)

This function is event handler and it is triggered when user clicks on offer.
It fires vlocity-dc-offer-selected.
Parameters:
Name Type Description
evt Object DOM Event