VlocityDCOfferPaymentConfig

VlocityDCOfferPaymentConfig

vlocity-dc-offer-payment-config is a web component for displaying payment option for an offer.

Features
1.Option to display and select one-time or recurring charge type.

Constructor

new VlocityDCOfferPaymentConfig()

Properties:
Name Type Description
offerObject OfferObject selected offer object.
selectedPaymentType String selected payment type eg. Recurring or One-time.
Example
Sample Usage -

Include the component in your template simply by adding vlocity-dc-offer-payment-config custom tag

<vlocity-dc-offer-payment-config .offerObject="${currentOffer}" .selectedPaymentType="${"Recurring"}">
</vlocity-dc-offer-payment-config>

  | Attribute Name        | Type Expected                                                                 | Required |
  |-----------------------|-------------------------------------------------------------------------------|----------|
  | offerObject           | It expects value in OfferObject format                                        | required |
  | selectedPaymentType   | It expects a value in String format (e.g. "Recurring","One-time")             | required |

--------------------------------------------------------------------------------------------------------------------------------------

 KEY INFO -

 events fired : none

 events registered : none

 Dependency - vlocity-dc-offer-payment-config is a component that is used to display payment option and is commonly used as a
 child of vlocity-dc-offer-config-details but it can also be used as an independent component.

               | Parent Component                  | Expected Child Component |
               |-----------------------------------|--------------------------|
               | vlocity-dc-offer-config-details   | none                     |
Sample with slots -

<vlocity-dc-offer-payment-config>
   <span slot="{slot_name}">
     Custom HTML elements goes here
   </span>
</vlocity-dc-offer-payment-config>

List of available slots -

| Slot names                      | Dynamic     | Description                 | Impact                             |
|---------------------------------|-------------|------------------------------------------------------------------|
| dc-offer-payment-config-wrapper | -           | Wrapper for component       | Replaces complete template DOM     |
| dc-recurring-add-on             | -           | Extra add on                | Adds DOM                           |
| dc-one-time-add-on              | -           | one-time-add-on             | Adds DOM                           |

Extends

  • LitElement

Members

(static, readonly) properties

Properties that will be available in the binding system
Properties:
Name Type Description
offerObject OfferObject selected offer object
selectedPaymentType String selected payment type eg. Recurring or One-time

Methods

(static) connectedCallback()

Invoked when vlocity-dc-offer-payment-config component is added to the document’s DOM.