@empathyco/x-components
Version:
Empathy X Components
29 lines (20 loc) • 1.83 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [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
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [config](./x-components.facetsstate.config.md) | | [FacetsConfig](./x-components.facetsconfig.md) | The current facets config [FacetsState.config](./x-components.facetsstate.config.md)<!-- -->. |
| [facets](./x-components.facetsstate.facets.md) | | Record<Facet\['id'\], Omit<Facet, 'filters'>> | The facets without their filters. |
| [filters](./x-components.facetsstate.filters.md) | | Record<Filter\['id'\], Filter> | Record of all available filters indexed by its id. |
| [groups](./x-components.facetsstate.groups.md) | | Record<Facet\['id'\], [GroupId](./x-components.groupid.md)<!-- -->> | Record specifying the group each facet belongs to. |
| [origin](./x-components.facetsstate.origin.md) | | [QueryOrigin](./x-components.queryorigin.md) \| null | The origin property of the request. |
| [params](./x-components.facetsstate.params.md) | | Dictionary<unknown> | The extra params property of the state. |
| [preselectedFilters](./x-components.facetsstate.preselectedfilters.md) | | RawFilter\[\] | Record of preselected filters indexed by its id. |
| [stickyFilters](./x-components.facetsstate.stickyfilters.md) | | Record<Filter\['id'\], Filter> | Record of sticky filters indexed by its id. |