Events

Table of contents

1. BEFORE_API_CALL
2. AFTER_API_CALL
3. BEFORE_RENDER
4. AFTER_RENDER
5. BEFORE_NO_RESULTS_RENDER
6. AFTER_NO_RESULTS_RENDER
7. DELETE_FACET
8. FACETS_CLICK
9. CLEAR_SORT
10. CHANGE_SORT
11. PAGE_NEXT
12. PAGE_PREV
13. CHANGE_INPUT
14. SET_CATEGORY_FILTER
15. DELETE_CATEGORY_FILTER
16. PAGESIZE_CHANGE
17. CONFIG_ERROR
18. RUNTIME_ERROR
19. FETCH_ERROR

Events

This section documents the different events fired by the Unbxd Library that you can use to perform custom actions. The onEvent config function is used to catch these events

All events are async, and can be caught in the config callback function onEvent.

BEFORE_API_CALL

“BEFORE_API_CALL” event typically refers to an event that is triggered immediately before a search API call. All data related to payload or browser url is already calculated before firing this event.

Example usage

onEvent: function(instance, "BEFORE_API_CALL", null) {
    /** Custom code here */
}

AFTER_API_CALL

Fired if the search api call is successful

Example usage

onEvent: function(instance, "AFTER_API_CALL", null) {
    /** Custom code here */
}

BEFORE_RENDER

Fired as the first step of execution of the reRender function

Example usage

onEvent: function(instance, "BEFORE_RENDER", null) {
    /** Custom code here */
}

AFTER_RENDER

Fired as the last step of execution of the reRender function

Example usage

onEvent: function(instance, "AFTER_RENDER", null) {
    /** Custom code here */
}

BEFORE_NO_RESULTS_RENDER

Fired before rendering the zero results UI, if the number of results in the search api are 0, as part of the reRender function

Example usage

onEvent: function(instance, "BEFORE_NO_RESULTS_RENDER", null) {
    /** Custom code here */
}

AFTER_NO_RESULTS_RENDER

Fired after rendering the zero results UI i.e. if the number of results in the search api are 0, as part of the reRender function

Example usage

onEvent: function(instance, "AFTER_NO_RESULTS_RENDER", null) {
    /** Custom code here */
}

DELETE_FACET

Fired on deleting a facet. (deleteFacet sdk action is used)

Arguments

1. facetName: facet name

Example usage

onEvent: function(instance, "DELETE_FACET", { facetName }) {
    /** Custom code here */
}

FACETS_CLICK

Fired on changing a facet value (changeFacet sdk action is used)

Arguments

1. facetName: facet name
   
2. facetData: selected facets data from the search object response

Example usage

onEvent: function(instance, "FACETS_CLICK", {
    facetName,
    facetData
}) {
    /** Custom code here */
}

CLEAR_SORT

Fired when current sort data is cleared (clearSort sdk action is used)

Example usage

onEvent: function(instance, "CLEAR_SORT", null) {
    /** Custom code here */
}

CHANGE_SORT

Fired when sort data is changed with new values (changeSort sdk action is used)

Arguments

1. sortVal: sort value

Example usage

onEvent: function(instance, "CHANGE_SORT", {
    sort:sortVal
}) {
    /** Custom code here */
}

PAGE_NEXT

Fired on click of a next page (next sdk action is used)

Arguments

1. next: Page number

Example usage

onEvent: function(instance, "PAGE_NEXT", {
    value:next
}) {
    /** Custom code here */
}

PAGE_PREV

Fired on click of a previous page (prev sdk action is used)

Arguments

1. prev: Page number

Example usage

onEvent: function(instance, "PAGE_PREV", {
     value:prev
}) {
    /** Custom code here */
}

CHANGE_INPUT

Fired on keywdown of searchbox element

Example usage

onEvent: function(instance, "CHANGE_INPUT", null) {
    /** Custom code here */
}

SET_CATEGORY_FILTER

Fired if in the search page, a category facet is clicked (setCategoryFilter sdk action is used)

Arguments

1. dataSet: Facet element data set

Example usage

onEvent: function(instance, "SET_CATEGORY_FILTER", dataSet) {
    /** Custom code here */
}

DELETE_CATEGORY_FILTER

Fired if in the search page, a category facet is cleared (clearCategoryFilter sdk action is used)

Arguments

1. dataSet: Facet element data set

Example usage

onEvent: function(instance, "DELETE_CATEGORY_FILTER", dataSet) {
    /** Custom code here */
}

PAGESIZE_CHANGE

Fired on click of any of the page size options

Arguments

1. val: New page size

Example usage

onEvent: function(instance, "PAGESIZE_CHANGE", {
    count:val
}) {
    /** Custom code here */
}

CONFIG_ERROR

This event is captured when any config error has occurred .

Arguments

1. payload: error object will be sent here by the sdk.

Example usage

onEvent: function(instance, "CONFIG_ERROR", {
    payload
}) {
    /** Custom code here */
}

RUNTIME_ERROR

This event is captured when any runtime error has occurred .

Arguments

1. payload: error object will be sent here by the sdk.

Example usage

onEvent: function(instance, "RUNTIME_ERROR", {
    payload
}) {
    /** Custom code here */
}

FETCH_ERROR

This event is captured when any error is occurred after an api call.

Arguments

1. payload: Any payload can be sent here .

Example usage

onEvent: function(instance, "FETCH_ERROR", {
    payload
}) {
    /** Custom code here */
}