@empathyco/x-components
Version:
Empathy X Components
32 lines (23 loc) • 2.64 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [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
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [SearchBoxQueryChanged](./x-components.searchboxxevents.searchboxquerychanged.md) | | string | The search-box query has changed Payload: The new search-box query. |
| [UserBlurredSearchBox](./x-components.searchboxxevents.userblurredsearchbox.md) | | void | The user removed the focus from the search-box. Payload: none. |
| [UserClearedQuery](./x-components.searchboxxevents.userclearedquery.md) | | string | 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. |
| [UserClickedSearchBox](./x-components.searchboxxevents.userclickedsearchbox.md) | | void | The user clicked on the search-box input. Payload: none. |
| [UserFocusedSearchBox](./x-components.searchboxxevents.userfocusedsearchbox.md) | | void | The user focused the search-box Payload: none. |
| [UserHoveredInSearchBox](./x-components.searchboxxevents.userhoveredinsearchbox.md) | | void | The user hovered in the search-box. Payload: none. |
| [UserHoveredOutSearchBox](./x-components.searchboxxevents.userhoveredoutsearchbox.md) | | void | The user hovered out the search-box. Payload: none. |
| [UserIsTypingAQuery](./x-components.searchboxxevents.useristypingaquery.md) | | string | The user is typing/pasting a query Payload: the partial query that the user is typing. |
| [UserPressedClearSearchBoxButton](./x-components.searchboxxevents.userpressedclearsearchboxbutton.md) | | void | The user triggered the button that clears the search-box Payload: none. |
| [UserPressedEnterKey](./x-components.searchboxxevents.userpressedenterkey.md) | | string | The user pressed the enter key with the focus on the search-box Payload: the new query of the search-box. |
| [UserPressedSearchButton](./x-components.searchboxxevents.userpressedsearchbutton.md) | | string | The user pressed the search button Payload: The query to search. |
| [UserTalked](./x-components.searchboxxevents.usertalked.md) | | string | The user voiced a query Payload: The spoken query. |