Live Search Events

Live Search uses events to power search algorithms such as “Most Viewed”, and “Viewed This, Viewed That”. While the Commerce sample Luma theme gets eventing out of the box, headless and other custom implementations have to implement eventing for their own needs.

This table describes the events used by Live Search ranking strategies.

Required dashboard events

Some events are required to populate the Live Search dashboard

Required contexts

All events require the Page and Storefront contexts. This should happen at the page level/storefront application layer rather than when generating individual events (for example, in a PHP storefront, the PHP application container is responsible for setting them at runtime).

Usage

Here is a sample implementation of the search-request-sent event:

const mse = window.magentoStorefrontEvents;

/* set in application container */
// mse.context.page(pageCtx);
// mse.context.setStorefrontInstance(storefrontCtx);

/* set before firing event */
mse.context.setSearchInput(searchInputCtx);
mse.publish.searchRequestSent("search-bar");

Caveats