UNPKG

@empathyco/x-components

Version:
25 lines (16 loc) 1.93 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md) ## QueriesPreviewXEvents interface Dictionary of the events of QueriesPreview 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 QueriesPreviewXEvents ``` ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [QueryPreviewMounted](./x-components.queriespreviewxevents.querypreviewmounted.md) | | string | The query preview has been mounted. Payload: The query preview query as a key converted into a unique id (query hash). | | [QueryPreviewRequestUpdated](./x-components.queriespreviewxevents.querypreviewrequestupdated.md) | | SearchRequest | Any property of cacheable queries preview request has changed. Payload: The new [request](./x-types.searchrequest.md)<!-- -->. | | [QueryPreviewUnmounted](./x-components.queriespreviewxevents.querypreviewunmounted.md) | | { queryPreviewHash: string; cache: boolean; } | The query preview has been unmounted. Payload: The query preview's unique id (query hash) and its cache value. | | [QueryPreviewUnselected](./x-components.queriespreviewxevents.querypreviewunselected.md) | | Dictionary&lt;unknown&gt; | The query preview has been unselected. Payload: The extra params to be restored in the modules affected by the query preview selection. | | [UserAcceptedAQueryPreview](./x-components.queriespreviewxevents.useracceptedaquerypreview.md) | | [QueryPreviewInfo](./x-components.querypreviewinfo.md) | User has clicked on a query preview. Payload: The [query preview info](./x-components.querypreviewinfo.md) of the selected [item](./x-components.querypreviewitem.md)<!-- -->. |