@empathyco/x-components/docs/API-reference/api/x-components.searchxevents.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SearchXEvents](./x-components.searchxevents.md)

## SearchXEvents interface

Dictionary of the events of Search XModule, where each key is the event name, and the value is the event payload type or `void` if it has no payload.

**Signature:**

```typescript
export interface SearchXEvents 
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[FacetsChanged](./x-components.searchxevents.facetschanged.md)


</td><td>


</td><td>

Facet\[\]


</td><td>

The facets have changed. Payload: The [facets](./x-types.facet.md) array.


</td></tr>
<tr><td>

[PageChanged](./x-components.searchxevents.pagechanged.md)


</td><td>


</td><td>

number


</td><td>

Page has been changed. Payload: The new page number.


</td></tr>
<tr><td>

[ReloadSearchRequested](./x-components.searchxevents.reloadsearchrequested.md)


</td><td>


</td><td>

void


</td><td>

Reload the current search has been requested.


</td></tr>
<tr><td>

[ResultsChanged](./x-components.searchxevents.resultschanged.md)


</td><td>


</td><td>

Result\[\]


</td><td>

Results have been changed. Payload: The new [results](./x-types.result.md)<!-- -->.


</td></tr>
<tr><td>

[SearchRequestChanged](./x-components.searchxevents.searchrequestchanged.md)


</td><td>


</td><td>

[InternalSearchRequest](./x-components.internalsearchrequest.md) \| null


</td><td>

Any property of the search request has changed. Payload: The new search request or `null` if there is not enough data in the state to conform a valid request.


</td></tr>
<tr><td>

[SearchRequestUpdated](./x-components.searchxevents.searchrequestupdated.md)


</td><td>


</td><td>

[InternalSearchRequest](./x-components.internalsearchrequest.md) \| null


</td><td>

Any property of the search request has been updated. Payload: The new search request or `null` if there is not enough data in the state to conform a valid request.


</td></tr>
<tr><td>

[SearchResponseChanged](./x-components.searchxevents.searchresponsechanged.md)


</td><td>


</td><td>

[InternalSearchResponse](./x-components.internalsearchresponse.md)


</td><td>

A search response has been provided. Payload: The provided internal response object.


</td></tr>
<tr><td>

[SearchTaggingChanged](./x-components.searchxevents.searchtaggingchanged.md)


</td><td>


</td><td>

TaggingRequest


</td><td>

Query tagging has been changed. Payload: The new query tagging object.


</td></tr>
<tr><td>

[SelectedSortProvided](./x-components.searchxevents.selectedsortprovided.md)


</td><td>


</td><td>

Sort


</td><td>

A new selected sort has been provided. Payload: The sort option that has been provided.


</td></tr>
<tr><td>

[SortChanged](./x-components.searchxevents.sortchanged.md)


</td><td>


</td><td>

string


</td><td>

Sort has been changed. Payload: The new sort string.


</td></tr>
<tr><td>

[SpellcheckChanged](./x-components.searchxevents.spellcheckchanged.md)


</td><td>


</td><td>

string


</td><td>

Spellcheck has been changed. Payload: The new spellcheckedQuery string.


</td></tr>
<tr><td>

[UserClickedABanner](./x-components.searchxevents.userclickedabanner.md)


</td><td>


</td><td>

Banner


</td><td>

The user has clicked a banner. Payload: The clicked banner.


</td></tr>
<tr><td>

[UserClickedAbortARedirection](./x-components.searchxevents.userclickedabortaredirection.md)


</td><td>


</td><td>

void


</td><td>

The user has aborted a redirection.


</td></tr>
<tr><td>

[UserClickedAPromoted](./x-components.searchxevents.userclickedapromoted.md)


</td><td>


</td><td>

Promoted


</td><td>

The user has clicked a promoted. Payload: The clicked promoted.


</td></tr>
<tr><td>

[UserClickedARedirection](./x-components.searchxevents.userclickedaredirection.md)


</td><td>


</td><td>

Redirection


</td><td>

The user has clicked a redirection. Payload: The clicked redirection.


</td></tr>
<tr><td>

[UserClickedASort](./x-components.searchxevents.userclickedasort.md)


</td><td>


</td><td>

Sort


</td><td>

The user has clicked one of the sorts. Payload: The sort option that the user has selected.


</td></tr>
<tr><td>

[UserClickedPartialQuery](./x-components.searchxevents.userclickedpartialquery.md)


</td><td>


</td><td>

string


</td><td>

Partial query has been set. Payload: The new query string.


</td></tr>
<tr><td>

[UserReachedResultsListEnd](./x-components.searchxevents.userreachedresultslistend.md)


</td><td>


</td><td>

void


</td><td>

The user reached the limit of the scrollable content in a results list.


</td></tr>
<tr><td>

[UserSelectedAPage](./x-components.searchxevents.userselectedapage.md)


</td><td>


</td><td>

number


</td><td>

The user has selected a page.


</td></tr>
</tbody></table>