@empathyco/x-components
Version:
Empathy X Components
24 lines (14 loc) • 1.24 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [FacetsGroup](./x-components.facetsgroup.md)
## FacetsGroup interface
An object containing a list of facets, and the group they belong to.
The facet group is used to perform operations over a list of facets. For example, some APIs have dynamic facets. This means that depending on the selected filters, some facets can be returned. For example if you select `category:television`<!-- -->, a new facet called \*Screen size\* might appear. And, because now filters are stored in a dictionary instead of an array, and overridden with each request, when the user performs a new query, we have to remove all the `Screen size` filters because we don't know if the API will return them or not in the new query.
**Signature:**
```typescript
export interface FacetsGroup
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [facets](./x-components.facetsgroup.facets.md) | | Facet\[\] | The list of facets that belong to the group. |
| [id](./x-components.facetsgroup.id.md) | | string | The group unique identifier. |