@empathyco/x-components
Version:
Empathy X Components
155 lines (68 loc) • 1.87 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [QueryPreviewItem](./x-components.querypreviewitem.md)
## QueryPreviewItem interface
QueriesPreview store state.
**Signature:**
```typescript
export interface QueryPreviewItem extends StatusState
```
**Extends:** [StatusState](./x-components.statusstate.md)
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[displayTagging?](./x-components.querypreviewitem.displaytagging.md)
</td><td>
</td><td>
TaggingRequest
</td><td>
_(Optional)_ Display tagging info.
</td></tr>
<tr><td>
[instances](./x-components.querypreviewitem.instances.md)
</td><td>
</td><td>
number
</td><td>
The number of instances showing the query preview .
</td></tr>
<tr><td>
[queryTagging?](./x-components.querypreviewitem.querytagging.md)
</td><td>
</td><td>
TaggingRequest
</td><td>
_(Optional)_ Query tagging info.
</td></tr>
<tr><td>
[request](./x-components.querypreviewitem.request.md)
</td><td>
</td><td>
SearchRequest
</td><td>
Request object to retrieve the query preview using the search adapter, or null if there is no valid data to conform a valid request.
</td></tr>
<tr><td>
[results](./x-components.querypreviewitem.results.md)
</td><td>
</td><td>
Result\[\]
</td><td>
Results of the query preview request.
</td></tr>
<tr><td>
[totalResults](./x-components.querypreviewitem.totalresults.md)
</td><td>
</td><td>
number
</td><td>
The total number of results for the search query.
</td></tr>
</tbody></table>