@empathyco/x-components/docs/API-reference/api/x-components.searchboxxevents.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; [SearchBoxXEvents](./x-components.searchboxxevents.md)

## SearchBoxXEvents interface

Dictionary of the events of SearchBox 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 SearchBoxXEvents 
```

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[SearchBoxQueryChanged](./x-components.searchboxxevents.searchboxquerychanged.md)


</td><td>


</td><td>

string


</td><td>

The search-box query has changed Payload: The new search-box query.


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

[UserBlurredSearchBox](./x-components.searchboxxevents.userblurredsearchbox.md)


</td><td>


</td><td>

void


</td><td>

The user removed the focus from the search-box. Payload: none.


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

[UserClearedQuery](./x-components.searchboxxevents.userclearedquery.md)


</td><td>


</td><td>

string


</td><td>

The user cleared the search-box query in any way, typing or pressing a button that clears it. The payload is usually an empty string. Payload: string.


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

[UserClickedSearchBox](./x-components.searchboxxevents.userclickedsearchbox.md)


</td><td>


</td><td>

void


</td><td>

The user clicked on the search-box input. Payload: none.


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

[UserFocusedSearchBox](./x-components.searchboxxevents.userfocusedsearchbox.md)


</td><td>


</td><td>

void


</td><td>

The user focused the search-box Payload: none.


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

[UserHoveredInSearchBox](./x-components.searchboxxevents.userhoveredinsearchbox.md)


</td><td>


</td><td>

void


</td><td>

The user hovered in the search-box. Payload: none.


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

[UserHoveredOutSearchBox](./x-components.searchboxxevents.userhoveredoutsearchbox.md)


</td><td>


</td><td>

void


</td><td>

The user hovered out the search-box. Payload: none.


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

[UserIsTypingAQuery](./x-components.searchboxxevents.useristypingaquery.md)


</td><td>


</td><td>

string


</td><td>

The user is typing/pasting a query Payload: the partial query that the user is typing.


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

[UserPressedClearSearchBoxButton](./x-components.searchboxxevents.userpressedclearsearchboxbutton.md)


</td><td>


</td><td>

void


</td><td>

The user triggered the button that clears the search-box Payload: none.


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

[UserPressedEnterKey](./x-components.searchboxxevents.userpressedenterkey.md)


</td><td>


</td><td>

string


</td><td>

The user pressed the enter key with the focus on the search-box Payload: the new query of the search-box.


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

[UserPressedSearchButton](./x-components.searchboxxevents.userpressedsearchbutton.md)


</td><td>


</td><td>

string


</td><td>

The user pressed the search button Payload: The query to search.


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

[UserTalked](./x-components.searchboxxevents.usertalked.md)


</td><td>


</td><td>

string


</td><td>

The user voiced a query Payload: The spoken query.


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