@empathyco/x-components
Version:
Empathy X Components
116 lines (51 loc) • 1.33 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [QueryPreviewInfo](./x-components.querypreviewinfo.md)
## QueryPreviewInfo interface
Information to render or request a query preview with.
**Signature:**
```typescript
export interface QueryPreviewInfo
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[extraParams?](./x-components.querypreviewinfo.extraparams.md)
</td><td>
</td><td>
Dictionary<unknown>
</td><td>
_(Optional)_ The extra params to perform the search.
</td></tr>
<tr><td>
[filters?](./x-components.querypreviewinfo.filters.md)
</td><td>
</td><td>
string\[\]
</td><td>
_(Optional)_ The filters to perform the search.
</td></tr>
<tr><td>
[query](./x-components.querypreviewinfo.query.md)
</td><td>
</td><td>
string
</td><td>
The query to search for.
</td></tr>
<tr><td>
[title?](./x-components.querypreviewinfo.title.md)
</td><td>
</td><td>
string
</td><td>
_(Optional)_ An optional title for the container.
</td></tr>
</tbody></table>