JavaScript events for developers


Impulse makes heavy use of JavaScript to speed up loading times and make features like quick view really, well, quick. At times you may want to hook into these events after they happen to run your own custom script or integrate a third-party app.

All objects returned are vanilla JS objects and can be manipulated however you see fit.

Stylesheet has loaded and page is visible

Added in v3.4.0

Necessary because we only load some critical CSS inline — enough to show the page loader and some base styles — before lazyloading the rest of the stylesheet. Use this listener instead of document.onload.

document.addEventListener('page:loaded', function() {

Cart updated

Added in v3.5.0

JavaScript updates the cart object after the quantity is changed. This event is triggered after the cart markup is updated and is free to customize.

Cart object returned.

document.addEventListener('cart:updated', function(evt) {

Trigger cart drawer to update

Added in v3.5.0

You've adjusted the cart item quantity or need to reprint the entire cart drawer. Use cart:updated listener after to get cart object.

document.dispatchEvent(new CustomEvent('cart:build'));

Product added to the ajax cart

Added in v3.5.0

Product object returned.

document.addEventListener('ajaxProduct:added', function(evt) {

Product failed to add to cart

Added in v3.5.0

The error message will let you know the problem. Most of the time it is quantity related.

document.addEventListener('ajaxProduct:error', function(evt) {

Quick view modal is opened

Added in v3.5.0

The first time the modal is opened some elements are lazyloaded, such as the add to cart form. Those elements are not available right away.

evt.detail.initialized will be true if the quick view modal is opened a second time and all elements are available immediately.

Only the product ID is returned along with the initialized state (false).

document.addEventListener('quickview:open', function(evt) {

  if (evt.detail.initialized) {
    console.log('quickview:open | already initialized')
    var form = document.querySelector('#AddToCartForm-' + evt.detail.productId);
    var addToCart = document.querySelector('#ProductSection-' + evt.detail.productId + ' .add-to-cart');

Quick view modal loaded

Added in v3.5.0

Only fires the first time the modal is opened.

Only the product ID is returned.

document.addEventListener('quickview:loaded', function(evt) {
  var form = document.querySelector('#AddToCartForm-' + evt.detail.productId);

Variant selection changed

Added in v3.5.0

Variant object returned.

document.addEventListener('variant:change', function(evt) {

Collection page is re-rendered

Added in v5.4.1

Fired when the collection page is re-rendered after filters are updated.

document.addEventListener('collection:reloaded', function() {});

Related and complementary products loaded

This event will trigger when the product recommendations are done loading in.

document.addEventListener('recommendations:loaded', function(evt) {

evt.detail.section will return the recommendations in the DOM

evt.detail.intent will return a string detailing the type of product recommendations ‘related’ or ‘complementary’