@empathyco/x-components
Version:
Empathy X Components
74 lines • 2.04 kB
TypeScript
/**
* 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.
*
* @public
*/
export interface SearchBoxXEvents {
/**
* The search-box query has changed
* Payload: The new search-box query.
*/
SearchBoxQueryChanged: string;
/**
* The user hovered in the search-box.
* Payload: none.
*/
UserHoveredInSearchBox: void;
/**
* The user hovered out the search-box.
* Payload: none.
*/
UserHoveredOutSearchBox: void;
/**
* The user removed the focus from the search-box.
* Payload: none.
*/
UserBlurredSearchBox: void;
/**
* The user cleared the search-box query in any way, typing or pressing a button that clears it.
* Payload: none.
*/
/**
* 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.
*/
UserClearedQuery: string;
/**
* The user clicked on the search-box input.
* Payload: none.
*/
UserClickedSearchBox: void;
/**
* The user focused the search-box
* Payload: none.
*/
UserFocusedSearchBox: void;
/**
* The user is typing/pasting a query
* Payload: the partial query that the user is typing.
*/
UserIsTypingAQuery: string;
/**
* The user triggered the button that clears the search-box
* Payload: none.
*/
UserPressedClearSearchBoxButton: void;
/**
* The user pressed the enter key with the focus on the search-box
* Payload: the new query of the search-box.
*/
UserPressedEnterKey: string;
/**
* The user pressed the search button
* Payload: The query to search.
*/
UserPressedSearchButton: string;
/**
* The user voiced a query
* Payload: The spoken query.
*/
UserTalked: string;
}
//# sourceMappingURL=events.types.d.ts.map