@empathyco/x-components
Version:
Empathy X Components
32 lines (23 loc) • 2.46 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [FacetsMutations](./x-components.facetsmutations.md)
## FacetsMutations interface
Facets store mutations.
**Signature:**
```typescript
export interface FacetsMutations extends QueryMutations, ConfigMutations<FacetsState>
```
**Extends:** [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[FacetsState](./x-components.facetsstate.md)<!-- -->>
## Methods
| Method | Description |
| --- | --- |
| [clearStickyFilters()](./x-components.facetsmutations.clearstickyfilters.md) | Removes all the filters from the [sticky filters](./x-components.facetsstate.stickyfilters.md) record. |
| [mutateFilter(payload)](./x-components.facetsmutations.mutatefilter.md) | Updates the state of a filter. |
| [removeFacet(facet)](./x-components.facetsmutations.removefacet.md) | Removes the facet from the [facets](./x-components.facetsstate.facets.md) record. |
| [removeFilter(filter)](./x-components.facetsmutations.removefilter.md) | Removes the filter from the [filters](./x-components.facetsstate.filters.md) record. |
| [removeFilters(filters)](./x-components.facetsmutations.removefilters.md) | Removes a list of filters from the [filters](./x-components.facetsstate.filters.md) record. |
| [removeStickyFilter(filter)](./x-components.facetsmutations.removestickyfilter.md) | Removes the filter from the [sticky filters](./x-components.facetsstate.stickyfilters.md) record. |
| [setFacet(facet)](./x-components.facetsmutations.setfacet.md) | Adds the facet to the [facets](./x-components.facetsstate.facets.md) record. |
| [setFacetGroup(facetGroupEntry)](./x-components.facetsmutations.setfacetgroup.md) | Sets the group id of the facet. |
| [setFilters(filters)](./x-components.facetsmutations.setfilters.md) | Adds a list of filters to the [filters](./x-components.facetsstate.filters.md) record. |
| [setPreselectedFilters(filters)](./x-components.facetsmutations.setpreselectedfilters.md) | Adds a list of filters to the [preselectedFilters](./x-components.facetsstate.preselectedfilters.md) record. |
| [setStickyFilter(filter)](./x-components.facetsmutations.setstickyfilter.md) | Adds the filter to the [sticky filters](./x-components.facetsstate.stickyfilters.md) record. |