@empathyco/x-components
Version:
Empathy X Components
154 lines (67 loc) • 2.67 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [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
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[QueriesPreviewChanged](./x-components.queriespreviewxevents.queriespreviewchanged.md)
</td><td>
</td><td>
Dictionary<[QueryPreviewItem](./x-components.querypreviewitem.md)<!-- -->>
</td><td>
The query preview has been changed. Payload: The query preview item.
</td></tr>
<tr><td>
[QueryPreviewMounted](./x-components.queriespreviewxevents.querypreviewmounted.md)
</td><td>
</td><td>
string
</td><td>
The query preview has been mounted. Payload: The query preview query as a key converted into a unique id (query hash).
</td></tr>
<tr><td>
[QueryPreviewRequestUpdated](./x-components.queriespreviewxevents.querypreviewrequestupdated.md)
</td><td>
</td><td>
SearchRequest
</td><td>
Any property of cacheable queries preview request has changed. Payload: The new [request](./x-types.searchrequest.md)<!-- -->.
</td></tr>
<tr><td>
[QueryPreviewUnmounted](./x-components.queriespreviewxevents.querypreviewunmounted.md)
</td><td>
</td><td>
{ queryPreviewHash: string; cache: boolean; }
</td><td>
The query preview has been unmounted. Payload: The query preview's unique id (query hash) and its cache value.
</td></tr>
<tr><td>
[QueryPreviewUnselected](./x-components.queriespreviewxevents.querypreviewunselected.md)
</td><td>
</td><td>
Dictionary<unknown>
</td><td>
The query preview has been unselected. Payload: The extra params to be restored in the modules affected by the query preview selection.
</td></tr>
<tr><td>
[UserAcceptedAQueryPreview](./x-components.queriespreviewxevents.useracceptedaquerypreview.md)
</td><td>
</td><td>
[QueryPreviewInfo](./x-components.querypreviewinfo.md)
</td><td>
User has clicked on a query preview. Payload: The [query preview info](./x-components.querypreviewinfo.md) of the selected [item](./x-components.querypreviewitem.md)<!-- -->.
</td></tr>
</tbody></table>