README.md

Pickup Points Modal

A React component that renders VTEX's pickup points modal

Setup

Through NPM:

$ npm install @vtex/pickup-points-modal

import PickupPointsModal from '@vtex/pickup-points-modal/PickupPointsModal'

Through vtex.io:

Add vtex.pickup-points-modal to your manifest.json dependencies

import { PickupPointsModal } from 'vtex.pickup-points-modal'

API

Base Component

• PickupPointsModal

---

Base Component

PickupPointsModal

This component renders the modal with a list of pickup points and a map with markers

Props

• closePickupPointsModal: Callback function to be called when PickupPointsModal is closed
• changeActiveSLAOption: Callback function to be called when a pickup is selected
• changeActivePickupDetails: Callback function to be called when PickupPointDetails state is changed
• googleMapsKey: The Google Maps API Key
• items: Items array from orderForm to get the products information
• isPickupDetailsActive: (default: false) If the PickupPointDetails is active and should be rendered
• logisticsInfo: LogisticsInfo array from orderForm to get sla information
• onAddressChange: Callback function to be called when a the search field has changed
• pickupOptions: Array of pickup points (SLAs of type pickup-in-point)
• searchAddress: The current address used for the search input in the shape of AddressShapeWithValidation
• selectedPickupPoint: Current selected SLA of type pickup-in-point
• rules: The selected country rules from AddressForm
• sellerId: The Id of the seller when the list of pickups is filtered by seller
• storePreferencesData: Object from orderForm to get currency preferences from store
• salesChannel: String from orderForm to get the sales channel used in the checkout simulation
• orderFormId: String from orderForm used in the checkout simulation

PickupPointsModal.propTypes = {
  closePickupPointsModal: PropTypes.func.isRequired,
  changeActivePickupDetails: PropTypes.func.isRequired,
  changeActiveSLAOption: PropTypes.func.isRequired,
  googleMapsKey: PropTypes.string.isRequired,
  items: PropTypes.array.isRequired,
  isPickupDetailsActive: PropTypes.bool,
  logisticsInfo: PropTypes.array.isRequired
  onAddressChange: PropTypes.func.isRequired,
  pickupOptions: PropTypes.array.isRequired,
  searchAddress: AddressShapeWithValidation,
  selectedPickupPoint: PropTypes.object,
  rules: PropTypes.object,
  sellerId: PropTypes.string,
  storePreferencesData: PropTypes.object.isRequired,
  salesChannel: PropTypes.string.isRequired,
  orderFormId: PropTypes.string.isRequired,
};

Example

<PickupPointsModal
  closePickupPointsModal={this.closePickupModal}
  changeActivePickupDetails={this.changeActivePickupDetails}
  changeActiveSLAOption={this.changeActiveSLAOption}
  googleMapsKey={googleMapsKey}
  intl={intl}
  items={items}
  isPickupDetailsActive={isPickupDetailsActive}
  logisticsInfo={logisticsInfo}
  onAddressChange={this.handleAddressChange}
  orderFormId={orderFormId}
  pickupOptions={pickupOptions}
  searchAddress={searchAddress}
  selectedPickupPoint={selectedPickupPoint}
  selectedRules={selectedRules}
  sellerId={sellerId}
  storePreferencesData={storePreferencesData}
  salesChannel={salesChannel}
/>

Usage Metrics

You can track how the users are interacting with the pickup points modal via this Kibana dashboard (requires being logged on to the AWS VPN).

It might be of interest to keep an eye on it after deployments, to see if and how it affects user experience. Particularly, you can track if the pickup point selection "conversion rate" has gone up or down by comparing how often the modal has been opened vs. how often the users actually end up selecting a pickup point.