@empathyco/x-components/docs/API-reference/api/x-components.facetsstate.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; [FacetsState](./x-components.facetsstate.md)

## FacetsState interface

Facets store state.

**Signature:**

```typescript
export interface FacetsState 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>

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


</td><td>


</td><td>

[FacetsConfig](./x-components.facetsconfig.md)


</td><td>

The current facets config [FacetsState.config](./x-components.facetsstate.config.md)<!-- -->.


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

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


</td><td>


</td><td>

Record&lt;Facet\['id'\], Omit&lt;Facet, 'filters'&gt;&gt;


</td><td>

The facets without their filters.


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

[filters](./x-components.facetsstate.filters.md)


</td><td>


</td><td>

Record&lt;Filter\['id'\], Filter&gt;


</td><td>

Record of all available filters indexed by its id.


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

[groups](./x-components.facetsstate.groups.md)


</td><td>


</td><td>

Record&lt;Facet\['id'\], [GroupId](./x-components.groupid.md)<!-- -->&gt;


</td><td>

Record specifying the group each facet belongs to.


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

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


</td><td>


</td><td>

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


</td><td>

The origin property of the request.


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

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


</td><td>


</td><td>

Dictionary&lt;unknown&gt;


</td><td>

The extra params property of the state.


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

[preselectedFilters](./x-components.facetsstate.preselectedfilters.md)


</td><td>


</td><td>

RawFilter\[\]


</td><td>

Record of preselected filters indexed by its id.


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

[stickyFilters](./x-components.facetsstate.stickyfilters.md)


</td><td>


</td><td>

Record&lt;Filter\['id'\], Filter&gt;


</td><td>

Record of sticky filters indexed by its id.


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