UNPKG

@empathyco/x-components

Version:
31 lines (22 loc) 3.09 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [HistoryQueriesXEvents](./x-components.historyqueriesxevents.md) ## HistoryQueriesXEvents interface Dictionary of the events of HistoryQueries 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 HistoryQueriesXEvents ``` ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [HistoryQueriesDisplayed](./x-components.historyqueriesxevents.historyqueriesdisplayed.md) | | HistoryQuery\[\] | The current history queries have been displayed to the user. Payload: The displayed history queries. | | [HistoryQueriesQueryChanged](./x-components.historyqueriesxevents.historyqueriesquerychanged.md) | | string | The query for searching inside the history-queries has changed. Payload: The history-queries query. | | [HistoryQueriesStorageKeyChanged](./x-components.historyqueriesxevents.historyqueriesstoragekeychanged.md) | | string | The key for saving the history queries in to the browser storage has changed. Payload: The new history-queries storage key. | | [SessionHistoryQueriesChanged](./x-components.historyqueriesxevents.sessionhistoryquerieschanged.md) | | HistoryQuery\[\] | The queries made in the current session have changed Payload: The session history queries. | | [UserClickedConfirmDisableHistoryQueries](./x-components.historyqueriesxevents.userclickedconfirmdisablehistoryqueries.md) | | void | The user has clicked the confirm button to disable the history queries. Payload: None. | | [UserClickedDisableHistoryQueries](./x-components.historyqueriesxevents.userclickeddisablehistoryqueries.md) | | void | The user has clicked a control to disable the history queries. Payload: None. | | [UserClickedDismissDisableHistoryQueries](./x-components.historyqueriesxevents.userclickeddismissdisablehistoryqueries.md) | | void | The user has clicked the dismiss button to keep enabled the history queries. Payload: None. | | [UserClickedEnableHistoryQueries](./x-components.historyqueriesxevents.userclickedenablehistoryqueries.md) | | void | The user has clicked a control to enable the history queries. Payload: None. | | [UserPressedClearHistoryQueries](./x-components.historyqueriesxevents.userpressedclearhistoryqueries.md) | | void | The user pressed the button for clearing all the history queries. Payload: none. | | [UserPressedRemoveHistoryQuery](./x-components.historyqueriesxevents.userpressedremovehistoryquery.md) | | HistoryQuery | The user pressed the button for removing a single [history query](./x-types.historyquery.md)<!-- -->. Payload: The <code>HistoryQuery</code> to remove. | | [UserSelectedAHistoryQuery](./x-components.historyqueriesxevents.userselectedahistoryquery.md) | | HistoryQuery | The user has selected a history-query. Payload: The [history query](./x-types.historyquery.md) selected. |