@empathyco/x-components/docs/API-reference/api/x-types.previewable.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [Previewable](./x-types.previewable.md)

## Previewable interface

Represents an item that is searchable, and the results associated to it.

**Signature:**

```typescript
export interface Previewable 
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[facets?](./x-types.previewable.facets.md)


</td><td>


</td><td>

[Facet](./x-types.facet.md)<!-- -->\[\]


</td><td>

_(Optional)_ Facets to apply to the `query` property when searching.


</td></tr>
<tr><td>

[query](./x-types.previewable.query.md)


</td><td>


</td><td>

string


</td><td>

The query to search for.


</td></tr>
<tr><td>

[results?](./x-types.previewable.results.md)


</td><td>


</td><td>

[Result](./x-types.result.md)<!-- -->\[\] \| null


</td><td>

_(Optional)_ The results that the combination of `query` and `facets` properties return, or `null` if they have not been loaded yet.


</td></tr>
<tr><td>

[totalResults?](./x-types.previewable.totalresults.md)


</td><td>


</td><td>

number \| null


</td><td>

_(Optional)_ The number of results that the combination of `query` and `facets` properties return, or `null` if they have not been loaded yet.


</td></tr>
</tbody></table>