UNPKG

@empathyco/x-components

Version:
80 lines (36 loc) 1.47 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [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 <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> [facets](./x-components.facetsgroup.facets.md) </td><td> </td><td> Facet\[\] </td><td> The list of facets that belong to the group. </td></tr> <tr><td> [id](./x-components.facetsgroup.id.md) </td><td> </td><td> string </td><td> The group unique identifier. </td></tr> </tbody></table>