Skip to content
vviinn DocsDocs Beta

Text Search Events

Every vviinn widget emits events that you can listen to with document.addEventListener().

Text Search events are essential to connect the vviinn-text-search and vviinn-results components.

All these events are available on Text Search.

Name Description Props
vviinnTextSearchStarted Triggered when a text search was initiated.

Not emitted when:
- results-page-url is set and the user is not on the results page
- Query mapping returns an auto-suggest redirect

In both cases, vviinnRedirect is emitted instead.
query
isTriggeredByVpsWidget
vviinnImageUploadFinished Triggered when an image search ID was received. searchId
isTriggeredByVpsWidget
document.addEventListener("vviinnTextSearchStarted", ({ detail }) => {
console.log(detail);
});
// Output:
{
"query": "kitchen",
"isTriggeredByVpsWidget": false
}