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

Empathy X Components

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

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SearchState](./x-components.searchstate.md)

## SearchState interface

Search store state.

**Signature:**

```typescript
export interface SearchState extends StatusState, QueryState 
```
**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[banners](./x-components.searchstate.banners.md)


</td><td>


</td><td>

Banner\[\]


</td><td>

The list of the banners, related to the `query` property of the state.


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

[config](./x-components.searchstate.config.md)


</td><td>


</td><td>

[SearchConfig](./x-components.searchconfig.md)


</td><td>

The configuration of the search module.


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

[displayTagging](./x-components.searchstate.displaytagging.md)


</td><td>


</td><td>

TaggingRequest


</td><td>

The display tagging used to track the search events.


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

[facets](./x-components.searchstate.facets.md)


</td><td>


</td><td>

Facet\[\]


</td><td>

The list of the facets, related to the `query` property of the state.


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

[fromNoResultsWithFilters](./x-components.searchstate.fromnoresultswithfilters.md)


</td><td>


</td><td>

boolean


</td><td>

Flag indicating if there is a no results situation with filters selected.


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

[isAppendResults](./x-components.searchstate.isappendresults.md)


</td><td>


</td><td>

boolean


</td><td>

A flag to indicate if new results are append to the current instead of replacing them.


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

[isNoResults](./x-components.searchstate.isnoresults.md)


</td><td>


</td><td>

boolean


</td><td>

Flag indicating if there is a no results situation.


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

[origin](./x-components.searchstate.origin.md)


</td><td>


</td><td>

[QueryOrigin](./x-components.queryorigin.md) \| null


</td><td>

The origin property of the request.


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

[page](./x-components.searchstate.page.md)


</td><td>


</td><td>

number


</td><td>

The current page of the request.


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

[params](./x-components.searchstate.params.md)


</td><td>


</td><td>

Dictionary&lt;unknown&gt;


</td><td>

The extra params property of the state.


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

[partialResults](./x-components.searchstate.partialresults.md)


</td><td>


</td><td>

PartialResult\[\]


</td><td>

The list of the partial results, related to the `query` property of the state.


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

[promoteds](./x-components.searchstate.promoteds.md)


</td><td>


</td><td>

Promoted\[\]


</td><td>

The list of the promoted, related to the `query` property of the state.


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

[queryTagging](./x-components.searchstate.querytagging.md)


</td><td>


</td><td>

TaggingRequest


</td><td>

The query tagging used to track the search events.


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

[redirections](./x-components.searchstate.redirections.md)


</td><td>


</td><td>

Redirection\[\]


</td><td>

The redirections associated to the `query`<!-- -->.


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

[relatedTags](./x-components.searchstate.relatedtags.md)


</td><td>


</td><td>

RelatedTag\[\]


</td><td>

The list of the related tags, related to the `query` property of the state.


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

[results](./x-components.searchstate.results.md)


</td><td>


</td><td>

Result\[\]


</td><td>

The list of the results, related to the `query` property of the state.


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

[selectedFilters](./x-components.searchstate.selectedfilters.md)


</td><td>


</td><td>

Dictionary&lt;Filter\[\]&gt;


</td><td>

The dictionary of selected filters, used to perform the search request. The key is the facet id, and the value the list of filters for that facet.


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

[sort](./x-components.searchstate.sort.md)


</td><td>


</td><td>

Sort


</td><td>

The way of ordering the results.


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

[spellcheckedQuery](./x-components.searchstate.spellcheckedquery.md)


</td><td>


</td><td>

string


</td><td>

The spellcheckedQuery property of the state.


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

[stats](./x-components.searchstate.stats.md)


</td><td>


</td><td>

Stats


</td><td>

The stats of the results.


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

[totalResults](./x-components.searchstate.totalresults.md)


</td><td>


</td><td>

number


</td><td>

The total number of results, related to the `query` property of the state.


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