Custom Events
Fast Simon Upsell & Cross-Sell dispatching custom events for any use like analytics and more. This way you are able to targeting important events at the moment they fired.
Getting Started
PLP custom events
- Register an event listener using a script tag located in the
<head> - Each time an event is fired within the PLP, we will dispatch the custom event including all the relevant data.
Register a new custom event listener & run a callback once fired
<script>
function productAddedToCartCallback(productData) {
// ...code here
}
window.addEventListener('fs-rec-custom-events-product-added-to-cart', (e) => {
productAddedToCartCallback(e.detail);
});
</script>
Available Events
| Event Name | Description | Event Data |
|---|---|---|
| "fs-rec-custom-events-add-to-cart-click" | Event is fired on product add to cart click | productData: Product |
| "fs-rec-custom-events-product-added-to-cart" | Event is fired each time product added to the cart | productData: Product |
| "fs-rec-custom-events-quick-view-btn-clicked" | Event is fired when clicking on quickview button | {productId: string, productURL: string } |
| "fs-rec-events-product-quick-add-clicked" | Event is fired when clicking on quick add button | productData: Product |
| "fs-rec-events-product-swatch-on-click" | Event is fired when clicking on color swatch option button | {alt: AlternativeProduct[], image: string, sku: string, redirectURL: string, title: string} |
Open a popup widget from your own code
A widget with Display Type set to Popup registers itself on window.FastSimonRecommendations.UpsellCrossSell.modals under its widget ID once it has loaded on the page.
| Method | Description |
|---|---|
open() | Opens the popup |
close() | Closes the popup |
isOpen() | Returns whether the popup is open |
Set Popup Trigger to Custom in the Widget Editor so that the widget does not open on add to cart by itself, then open it when your own condition is met:
<script>
function openUpsellPopup() {
window.FastSimonRecommendations?.UpsellCrossSell?.modals?.['YOUR_WIDGET_ID']?.open();
}
</script>
The widget must be installed on the page. Until it has loaded, the call above does nothing.
type references: Typescript Types