@empathyco/x-components
Version:
Empathy X Components
32 lines (23 loc) • 2.89 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)<!-- -->>
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [clearStickyFilters](./x-components.facetsmutations.clearstickyfilters.md) | | () => void | Removes all the filters from the [sticky filters](./x-components.facetsstate.stickyfilters.md) record. |
| [mutateFilter](./x-components.facetsmutations.mutatefilter.md) | | (payload: [MutateFilterPayload](./x-components.mutatefilterpayload.md)<!-- -->) => void | Updates the state of a filter. |
| [removeFacet](./x-components.facetsmutations.removefacet.md) | | (facet: Facet) => void | Removes the facet from the [facets](./x-components.facetsstate.facets.md) record. |
| [removeFilter](./x-components.facetsmutations.removefilter.md) | | (filter: Filter) => void | Removes the filter from the [filters](./x-components.facetsstate.filters.md) record. |
| [removeFilters](./x-components.facetsmutations.removefilters.md) | | (filters: Filter\[\]) => void | Removes a list of filters from the [filters](./x-components.facetsstate.filters.md) record. |
| [removeStickyFilter](./x-components.facetsmutations.removestickyfilter.md) | | (filter: RawFilter) => void | Removes the filter from the [sticky filters](./x-components.facetsstate.stickyfilters.md) record. |
| [setFacet](./x-components.facetsmutations.setfacet.md) | | (facet: Facet) => void | Adds the facet to the [facets](./x-components.facetsstate.facets.md) record. |
| [setFacetGroup](./x-components.facetsmutations.setfacetgroup.md) | | (facetGroupEntry: [FacetGroupEntry](./x-components.facetgroupentry.md)<!-- -->) => void | Sets the group id of the facet. |
| [setFilters](./x-components.facetsmutations.setfilters.md) | | (filters: Filter\[\]) => void | Adds a list of filters to the [filters](./x-components.facetsstate.filters.md) record. |
| [setPreselectedFilters](./x-components.facetsmutations.setpreselectedfilters.md) | | (filters: RawFilter\[\]) => void | Adds a list of filters to the [preselectedFilters](./x-components.facetsstate.preselectedfilters.md) record. |
| [setStickyFilter](./x-components.facetsmutations.setstickyfilter.md) | | (filter: RawFilter) => void | Adds the filter to the [sticky filters](./x-components.facetsstate.stickyfilters.md) record. |