Frontend custom events

Customize

While the extension provides JavaScript libraries such as Autocomplete, InstantSearch, and Insights, your customizations modify the implementation, not the libraries. These libraries are here to help add to your customization. As the extension has already initialized these components, you should hook into the area between the extension and the libraries.

Frontend JavaScript libraries and the legacy bundle

Depending on your extension version, you can have different versions of the Autocomplete or InstantSearch libraries installed. For more information, refer to the extension’s repository. Knowing the version of the extension helps you understand what’s available in these libraries. It also helps you find which documentation to reference when you start working on your customization. Before version 3.15.0, the extension included a single minified bundle file called algoliaBundle.min.js to hold the Autocomplete and InstantSearch libraries and their dependencies. These were previously accessible from the global algoliaBundle and were added to most event hooks for access. As of version 3.15.0, support for the bundle has been discontinued and these libraries are now included individually in the Magento extension and loaded with RequireJS. This has a number of advantages:

Easier library upgrades as newer versions become available in between official releases of the Algolia Magento extension
Reduce asset size by excluding libraries that are not useful to your implementation
You can use mixins (in addition to Algolia’s frontend events) for easier customizations without having to override entire files
You can use your own JavaScript bundling approach such as standard and advanced bundling

If you’re using RequireJS, you can still load the algoliaBundle as a dependency, but be aware that it will be removed in a future release. Hooks still pass the bundle as an argument as in previous versions of the extension, but the object won’t contain all legacy libraries that were previously included in the bundle. If you need any of these libraries for your customizations, see Bundle stuffing.

What’s included?

Libraries that are packaged with the extension include:

algolia-search.min.js and algolia-search-helper.min.js for communicating with Algolia from the frontend
algolia-instantsearch.min.js for building the search interface with InstantSearch
algolia-autocomplete.min.js for building the Autocomplete search box
search-insights.min.js for the insights features like Click and Conversion Analytics and Personalization
recommend.min.js and recommend-js.min.js to support Algolia Recommend features
hogan.min.js and mustache.min.js for legacy templating support

Accessing frontend configurations

The extension handles the implementation of the frontend features based on your configuration in Stores > Configuration > Algolia Search. The extension stores these settings in the global JavaScript object algoliaConfig. The data for this object returns from the block method Algolia\AlgoliaSearch\Block\Configuration::getConfiguration() and is set in the configuration.phtml template file. The Autocomplete and InstantSearch implementations refer to this global variable to build their UI. To inspect the algoliaConfig object, type algoliaConfig in your browser’s console when on your Magento store.

In this object, you can see references for search credentials, index name prefix, display settings for Autocomplete and InstantSearch, facets configuration, and other options related to the search UI. This is a helpful reference to understand what’s built on the frontend and for your customizations.

Dependency loading with RequireJS

Before version 3.10.3, the extension loaded its JavaScript resources with script tags. This had several disadvantages, such as:

Pollution of the global namespace
Inability to defer loading of JavaScript asynchronously to improve perceived page load times
Inability to ensure that all dependencies are always available to the calling resource

As a result, scenarios could arise where the needed libraries did not load in the intended order. From version 3.10.3, global Algolia objects are still supported for backward compatibility, but all Algolia JavaScript libraries are now loaded as RequireJS dependencies (following Magento recommendations). This update means that when referencing Algolia objects in the global window namespace in your custom implementation, first use require or define to ensure they’re loaded and ready for your customizations. For instance, several global objects are loaded by algoliaCommon, which contains the object algolia. If you want to reference this object to register a new frontend hook, you must pass algoliaCommon as a dependency. For example, the following naked call to the algolia object is no longer supported:

JavaScript

algolia.registerHook("afterAutocompleteSources", (sources, searchClient) => {
  console.log("Customizing the autocomplete sources...");
  return sources;
});

To ensure that this object is available to your script, surround your block as follows:

JavaScript

require(["algoliaCommon"], () => {
  algolia.registerHook("afterAutocompleteSources", (sources, searchClient) => {
    console.log("Customizing the autocomplete sources...");
    return sources;
  });
});

Even better, declare your custom file as a RequireJS AMD module using define and a declaration in requirejs-config.js. Refer to the “Where to place your hook” guidelines to implement an algoliaHooks override to guarantee that Algolia’s libraries (like Autocomplete and InstantSearch) load in the proper sequence after you have registered your custom hooks. For an example of how to implement this kind of customization, see the CustomAlgolia sample module on GitHub.

How to use event hooks

The extension provides hooks to help you add or change parameters for implementation. The algolia window variable is an object that handles the setting and firing of these events. (To ensure that the algolia object is available to your custom implementation, declare algoliaCommon as a RequireJS dependency.) Try typing algolia in your browser’s console when on your Magento store. Your console outputs an object with methods that help trigger events throughout the frontend implementation for Autocomplete, InstantSearch, and Insights. You can see all available events by entering algolia.allowedHooks in your browser’s console.

It’s highly recommended that you find where these events dispatch in the extension to help understand what parameters are available to use and what to return.

When it comes to the extension, the primary use of the algolia object is to add your callback function to the available events. To add your hook, use the algolia.registerHook method, which accepts the parameters of eventName and the callback function.

JavaScript

algolia.registerHook(
  "beforeWidgetInitialization",
  function (allWidgetConfiguration) {
    // add your code here
    return allWidgetConfiguration;
  },
);

The example adds the customisation at the beforeWidgetInitialization event. The event fires from the instantsearch.js file as:

JavaScript

allWidgetConfiguration = algolia.triggerHooks(
  "beforeWidgetInitialization",
  allWidgetConfiguration,
);

You can see that the event has access to the variable allWidgetConfiguration. This variable holds all the InstantSearch widgets configuration already created for you based on your extension settings. Using this event, you can return a modified allWidgetConfiguration for the InstantSearch implementation.

Where to place your hook

You must add your hook before the event fires by placing your JavaScript customization in your custom module or theme. Don’t edit the extension or override the extension files unless necessary. The extension adds JavaScript files using RequireJS. Using the dependency algoliaHooks ensures that your hooks fire at the appropriate time before the InstantSearch or Autocomplete UI is built. Override this file using requirejs-config.js as demonstrated below:

JavaScript

const config = {
  map: {
    "*": {
      algoliaHooks: "Algolia_CustomAlgolia/hooks",
    },
  },
};

To learn how to call and initialize JavaScript in Magento, see Introduction to JavaScript. For either option, the hook fires when the event triggers. It’s not necessary to wait for the DOM to be ready.

Debugging your hook

If your hook doesn’t fire, use your browser’s developer tools to add a break-point on the event. You can then inspect algolia.registeredHooks to see all the registered hooks added at that point of the script.

If your hook wasn’t added by this point, run your hook earlier by moving the customization higher in the loading order, but not before common.js. The extension requires that common.js runs before to access the algolia global. Please remember that hooks don’t need to wait for DOM ready. In fact, running it after DOM ready registers the hooks after the event fires which isn’t ideal. The following diagram demonstrates the process by which events are triggered when Autocomplete loads:

You can adjust all the logic of the autocomplete.js integration by registering a custom method in your JavaScript file. You can register hooks with the algolia object. To learn how to add a custom JavaScript, see Create a custom extension. Possible hooks:

afterAutocompleteSources(sources, algoliaClient)
- Can be used to modify default data sources
- The hook must return sources variable
afterAutocompletePlugins(plugins, algoliaClient)
- Can be used to modify default plugins
- The hook must return plugins variable
afterAutocompleteOptions(options)
- Can be used to modify default options of autocomplete menu
- The hook must return options variable
afterAutocompleteProductSourceOptions(options)
- Can be used to modify default options of the products source of autocomplete menu
- Are also referred to as search parameters
- The hook must return options variable

These hooks are triggered right before the autocomplete feature initializes. Examples of the hooks:

JavaScript

algolia.registerHook(
  "afterAutocompleteSources",
  function (sources, algoliaClient) {
    // Add or modify sources, then return them
    return sources;
  },
);

algolia.registerHook("afterAutocompleteOptions", function (options) {
  // Modify options, then return them
  return options;
});

algolia.registerHook(
  "afterAutocompleteProductSourceOptions",
  function (options) {
    // Modify options, then return them
    return options;
  },
);

afterAutocompleteStart(algoliaAutocompleteInstance)
- can be used to observe events on the autocomplete element
- the hook must return algoliaAutocompleteInstance variable

Example of the hook:

JavaScript

// Bind new event on the autocomplete element
algolia.registerHook(
  "afterAutocompleteStart",
  function (algoliaAutocompleteInstance) {
    // Modify default autocomplete instance, then return it
    return algoliaAutocompleteInstance;
  },
);

InstantSearch page events

You can adjust all the logic of the InstantSearch.js integration by registering a couple of custom hooks:

beforeInstantsearchInit(instantsearchOptions)
- Modifies default instantsearch options.
beforeWidgetInitialization(allWidgetConfiguration)
- Adds, removes, or modifies any widgets.
beforeInstantsearchStart(search)
- Modifies the instantsearch instance before calling the start() method.
afterInstantsearchStart(search)
- Modifies the instantsearch instance after calling the start() method.
beforeFacetInitialization(builders)
- Modifues the logic for any facet by means of “builder” functions which return a facet configuration that will drive the rendering and behavior of the facet.

By registering these hooks in your JavaScript file, you can directly modify their parameters which must be returned back from the method. Example of the beforeInstantsearchInit(instantsearchOptions) hook:

// Modify default `instantsearchOptions`
algolia.registerHook(
  "beforeInstantsearchInit",
  function (instantsearchOptions) {
    instantsearchOptions.onStateChange = function ({ uiState, setUiState }) {
      // Add your logic here
      setUiState(uiState);
    };

    return instantsearchOptions;
  },
);

// Modify default `searchParameters`
algolia.registerHook(
  "beforeWidgetInitialization",
  function (allWidgetConfiguration) {
    allWidgetConfiguration["configure"] =
      allWidgetConfiguration["configure"] || {};

    // Change hitsPerPage
    allWidgetConfiguration["configure"].hitsPerPage = 20;

    // change enabledPersonalization
    allWidgetConfiguration["configure"].enablePersonalization = true;

    // Adding a custom Query Rule context
    var newQueryRuleContext = "new-custom-query-rule-context";
    allWidgetConfiguration["configure"].ruleContexts.push(newQueryRuleContext);

    return allWidgetConfiguration;
  },
);

The following code shows how to add a new toggleRefinement widget to the InstantSearch page:

algolia.registerHook(
  "beforeWidgetInitialization",
  function (allWidgetConfiguration) {
    const wrapper = document.getElementById("instant-search-facets-container");
    const widgetConfig = {
      container: wrapper.appendChild(createISWidgetContainer("in_stock")),
      attribute: "in_stock",
      on: 1,
      templates: {
        label: "In Stock",
      },
    };

    if (typeof allWidgetConfiguration["toggleRefinement"] === "undefined") {
      allWidgetConfiguration["toggleRefinement"] = [widgetConfig];
    } else {
      allWidgetConfiguration["toggleRefinement"].push(widgetConfig);
    }

    return allWidgetConfiguration;
  },
);

All default widgets can be found in allWidgetConfiguration object and can be removed or modified in this method. However, some widgets, like hits, can not be added multiple times. In that case, you should add the widget manually in beforeInstantsearchStart:

define(["algoliaCommon", "algoliaInstantSearchLib"], function (
  algolia,
  instantsearch,
) {
  algolia.registerHook("beforeInstantsearchStart", function (search) {
    search.addWidgets([
      instantsearch.widgets.hits({
        container: "#custom-second-hits",
      }),
    ]);
    return search;
  });
});

The following code demonstrates how you might modify the color facet in any number of ways using the beforeFacetInitialization(builders) hook:

JavaScript

define(['algoliaCommon','algoliaInstantSearchLib'], function (algolia, instantsearch) { 
  algolia.registerHook(
      "beforeFacetInitialization",
      function (builders) {
          console.log("InstantSearch facet builders:", builders);

          // Add a new builder function for the `color` attribute
          builders.color = (facet) => {
              const options = {
                  attribute: facet.attribute,
                
                  container: algolia.createISWidgetContainer(facet.attribute),

                  // Override the default sort which sorts by `count:desc`
                  sortBy: ['name:asc'],

                  // Inject additional data into your facet items
                  transformItems(items, {results: {hits}}) {
                      return items.map(item => ({
                          ...item,
                          // For instance you might add a swatch URL - this could be extracted from the hits data which has been augmented to include this data through a customization
                          swatchUrl: 'https://placehold.co/16x16' //getSwatchUrlFromHits(hits) and so on.
                      }));
                  },

                  templates: {
                      item(item, { html }) {
                          const { url, label, count, isRefined, swatchUrl } = item;
                          // Include the swatch in the rendered item 
                          return html`
                              <a href="${url}" style="${isRefined ? 'font-weight: bold' : ''}">
                                <span><img src="${swatchUrl}"/> ${label} (${count})</span>
                              </a>
                            `;
                      },
                  },

                  // The Magento integration supports the inclusion of a `panelOptions` object to define how the wrapping panel might look or behave
                  panelOptions: {
                      templates: {
                          // Customizing the header
                          header: `<div class="name">CUSTOM FACET: ${facet.label}</div>`
                      },

                      // Control whether or not the panel appears 
                      hidden(options) {
                          return !options.results;
                      }
                  }
              };

              // Return a tuple of your desired widget type and the options to be passed to that widget 
              return ['refinementList', options];
          };

          return builders;
      }
  );
);

In the preceding example, a custom builder function is used to return the configuration for a refinementList widget.

Insights events

You can add new events for Click and Conversion Analytics and Personalization by registering this custom hook:

afterInsightsBindEvents(algoliaInsights)
- can be used to add new events
- algoliaInsights gives you access to methods for tracking:
  - trackClick(eventData)
  - trackView(eventData)
  - trackConversion(eventData)
- to format eventData for insights you can use:
  - buildEventData(eventName, objectID, indexName, position = null, queryID = null)
  - Click and Conversion Analytics requires the optional parameters for position and queryID

Example of a custom click event for personalization:

JavaScript

algolia.registerHook("afterInsightsBindEvents", function (algoliaInsights) {
  var selectors = document.querySelectorAll(".class-selector");
  selectors.forEach(function (e) {
    e.addEventListener("click", function (event) {
      // selector in this example has an data-objectid attribute
      // with the objectID as the value
      var objectId = this.dataset.objectid;

      // use the buildEventData function to format event data
      var eventData = algoliaInsights.buildEventData(
        "Clicked Event Name", // eventName
        objectId, // objectID
        algoliaConfig.indexName + "_products", // indexName
      );

      algoliaInsights.trackClick(eventData);
    });
  });
});

Example usages

You can use this section as inspiration for your customization. This examples creates a new section that displays categories with the product results. To learn more about templating, see Create a custom extension. To get the categories that are returned by a product search, you need to create a new section that queries the products index. When you define the source of this section, pass the facets parameter that returns the categories attribute which the extension indexes as: categories.level0 or categories.level2. The search returns product results as hits, so you need to render the facets instead of products. You can render the facets in the template suggestions function. Make sure that your template variables match those returned by the facets to render them in autocomplete.

JavaScript

algolia.registerHook(
  "beforeAutocompleteSources",
  function (sources, algoliaClient) {
    let source = {
      hitsPerPage: 2,
      label: "Category w/ Products ",
      name: "products",
      options: {
        analyticsTags: "autocomplete",
        clickAnalytics: true,
        distinct: true,
        facets: ["categories.level0, categories.level2"],
        maxValuesPerFacet: 3,
      },
      paramName: algoliaClient.initIndex(
        algoliaConfig.indexName + "_" + "products",
      ),
      templates: {
        noResults({ html }) {
          return "No Results";
        },
        header({ html, items }) {
          return "Category w/ Products";
        },
        item({ item, components, html }) {
          // Their Html will go here
        },
        footer({ html, items }) {
          return "";
        },
      },
    };
    sources.push(source);
    return sources;
  },
);

Add filters to your autocomplete search

To add a new filter, modify the section’s search parameters to include the new filter condition. To do this, you need to recreate the source with the updated options. The example below adds a new numericFilters to the search parameters, in_stock=1. To recreate the source value, you need to recreate the options passed into the product source as defined in common.js. The numericFilters returns an array of conditions that includes the new condition.

JavaScript

algolia.registerHook(
  "beforeAutocompleteProductSourceOptions",
  function (options) {
    ((options.analyticsTags = "autocomplete"),
      (options.clickAnalytics = true),
      (options.facets = ["categories.level0"]),
      (options.numericFilters = ["visibility_search=1", "in_stock=1"]));
    return options;
  },
);

Add custom rules context to InstantSearch

If you have to add new contexts for some of your custom rules, use the specified frontend hook for your InstantSearch version. You should add your new context to the preconfigured contexts:

algolia.registerHook(
  "beforeWidgetInitialization",
  function (allWidgetConfiguration) {
    // Adding a custom Query Rule context
    var newQueryRuleContext = "new-custom-query-rule-context";
    allWidgetConfiguration.configure.ruleContexts.push(newQueryRuleContext);

    return allWidgetConfiguration;
  },
);

By default, facet values displayed for a search are sorted by the number of matching results. The following example shows, how to sort the size facet values based on the size values. To do this, you need to hook into the event beforeWidgetInitialization to modify the facet for size. To sort the values in the refinementList based on size, add the sortBy function to the refinementList. This function lets you match values against each other and sort each value. To determine the order, use the orderedSizes array variable defined in the code below. This can be pulled from any source, like Magento or from another index if needed.

JavaScript

algolia.registerHook(
  "beforeWidgetInitialization",
  function (allWidgetConfiguration) {
    var orderedSizes = ["XXS", "XS", "S", "M", "L", "XL", "XXL"];

    for (var i = 0; i < allWidgetConfiguration.refinementList.length; i++) {
      if (allWidgetConfiguration.refinementList[i].attribute == "size") {
        allWidgetConfiguration.refinementList[i].sortBy = function (a, b) {
          return orderedSizes.indexOf(a.name) - orderedSizes.indexOf(b.name);
        };
      }
    }

    return allWidgetConfiguration;
  },
);

AdobeCommerce/Magento

Frontend custom events

Customize

Frontend JavaScript libraries and the legacy bundle

What’s included?

Accessing frontend configurations

Dependency loading with RequireJS

How to use event hooks

Where to place your hook

Debugging your hook

Autocomplete menu events

InstantSearch page events

Insights events

Example usages

Add category sorting in the Autocomplete menu

Add filters to your autocomplete search

Add custom rules context to InstantSearch

Sort facet values with InstantSearch

AdobeCommerce/Magento

​Customize

​Frontend JavaScript libraries and the legacy bundle

​What’s included?

​Accessing frontend configurations

​Dependency loading with RequireJS

​How to use event hooks

​Where to place your hook

​Debugging your hook

​Autocomplete menu events

​InstantSearch page events

​Insights events

​Example usages

​Add category sorting in the Autocomplete menu

​Add filters to your autocomplete search

​Add custom rules context to InstantSearch

​Sort facet values with InstantSearch

Customize

Frontend JavaScript libraries and the legacy bundle

What’s included?

Accessing frontend configurations

Dependency loading with RequireJS

How to use event hooks

Where to place your hook

Debugging your hook

Autocomplete menu events

InstantSearch page events

Insights events

Example usages

Add category sorting in the Autocomplete menu

Add filters to your autocomplete search

Add custom rules context to InstantSearch

Sort facet values with InstantSearch