Events

search.termChange

Detailed viewer event reference for search.termChange.

Summary

  • Category: Search
  • Event: search.termChange
  • Trigger: Fires when a new search term is requested.

Payload

[{ term: string; preventDefault: () => void }]

Payload fields

Payload is not an object literal. Use the declaration above and runtime guards when handling this event.

Subscription example

function onEvent(payload) {
  console.log('search.termChange', payload);
}

instance.addEventListener('search.termChange', onEvent);
instance.removeEventListener('search.termChange', onEvent);