@adobe/magento-storefront-event-collector

Magento storefront event collector

Usage no npm install needed!

<script type="module">
  import adobeMagentoStorefrontEventCollector from 'https://cdn.skypack.dev/@adobe/magento-storefront-event-collector';
</script>

README

Magento Storefront Event Collector

version downloads size build typescript contributing

Overview

This package listens for and handles events sent from the Magento Storefront Events SDK. It runs as a side effect and is meant to be a convenience for users who want to send events to Magento for processing.

Installation

The collector can be used as a hosted script, or bundled in a JavaScript application. The script version is hosted on unpkg, and the bundled version is hosted on npm.

To load the SDK as a script, use the following snippet.

<script src="https://unpkg.com/@adobe/magento-storefront-event-collector/dist/index.js"></script>

To install the script as a dependency, run this command.

npm install @adobe/magento-storefront-event-collector

Quick Start

After loading the collector script, or importing the package as shown below, there is nothing else that needs to be done.

import "@adobe/magento-storefront-event-collector";

The collector then begins listening for the following events.

  • addToCart
  • instantPurchase
  • pageView
  • placeOrder
  • productPageView
  • recsItemAddToCartClick
  • recsItemClick
  • recsRequestSent
  • recsResponseReceived
  • recsUnitRender
  • recsUnitView
  • searchCategoryClick
  • searchProductClick
  • searchRequestSent
  • searchResponseReceived
  • searchResultsView
  • searchSuggestionClick
  • shoppingCartView

When any of these events are fired, the collector runs the associated handler and sends the event along with any relevant information to Magento for further processing.

Support

If you have any questions or encounter any issues, please reach out at these locations.