@klevu/core
Version:
Typescript SDK that simplifies development on Klevu backend. Klevu provides advanced AI-powered search and discovery solutions for online retailers.
52 lines (51 loc) • 1.47 kB
TypeScript
/**
* @category KlevuEvents
* Global custom document events that @klevu/core sends
*/
export declare enum KlevuDomEvents {
/**
* When list of last searched terms update
*/
LastSearchUpdate = "klevu-last-search-update",
/**
* When filter manager selection has changed
*/
FilterSelectionUpdate = "klevu-filter-selection-updates",
/**
* When filters have been applied from results
*/
FiltersApplied = "klevu-filters-applied",
/**
* When any click event has been fired on the page
*/
ClickEventSent = "klevu-click-event-sent",
/**
* User consent given changed
*/
UserConsentGivenChanged = "klevu-user-consent-given-changed",
/**
* Use consent value changed
*/
UseConsentChanged = "klevu-use-consent-changed"
}
/**
* Helper function to listen Klevu Dom events
*
* @example ```ts
* import { KlevuDomEvents, KlevuListenDomEvent } from '@klevu/core'
*
* // Event to listen
* const stopListen = KlevuListenDomEvent(KlevuDomEvents.LastSearchUpdate, (event) => {
* console.log('last search updated!', event.detail)
* })
*
* // stop listening
* stopListen();
* ```
*
* @category KlevuEvents
* @param klevuDomEvent What event to listen
* @param callback What to do when event is fired
* @returns Function to stop listening
*/
export declare function KlevuListenDomEvent(klevuDomEvent: KlevuDomEvents, callback: (event: Event) => void): () => void;