UNPKG

@empathyco/x-components

Version:
34 lines (25 loc) 3.31 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [FacetsMutations](./x-components.facetsmutations.md) ## FacetsMutations interface Facets store mutations. **Signature:** ```typescript export interface FacetsMutations extends StatusMutations, QueryMutations, ConfigMutations<FacetsState> ``` **Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[FacetsState](./x-components.facetsstate.md)<!-- -->&gt; ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [clearStickyFilters](./x-components.facetsmutations.clearstickyfilters.md) | | () =&gt; 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)<!-- -->) =&gt; void | Updates the state of a filter. | | [removeFacet](./x-components.facetsmutations.removefacet.md) | | (facet: Facet) =&gt; void | Removes the facet from the [facets](./x-components.facetsstate.facets.md) record. | | [removeFilter](./x-components.facetsmutations.removefilter.md) | | (filter: Filter) =&gt; void | Removes the filter from the [filters](./x-components.facetsstate.filters.md) record. | | [removeFilters](./x-components.facetsmutations.removefilters.md) | | (filters: Filter\[\]) =&gt; void | Removes a list of filters from the [filters](./x-components.facetsstate.filters.md) record. | | [removeStickyFilter](./x-components.facetsmutations.removestickyfilter.md) | | (filter: RawFilter) =&gt; void | Removes the filter from the [sticky filters](./x-components.facetsstate.stickyfilters.md) record. | | [setFacet](./x-components.facetsmutations.setfacet.md) | | (facet: Facet) =&gt; 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)<!-- -->) =&gt; void | Sets the group id of the facet. | | [setFilters](./x-components.facetsmutations.setfilters.md) | | (filters: Filter\[\]) =&gt; void | Adds a list of filters to the [filters](./x-components.facetsstate.filters.md) record. | | [setOrigin](./x-components.facetsmutations.setorigin.md) | | (origin: [QueryOrigin](./x-components.queryorigin.md) \| undefined \| null) =&gt; void | Sets the origin of the module. | | [setParams](./x-components.facetsmutations.setparams.md) | | (params: Dictionary&lt;unknown&gt;) =&gt; void | Sets the extra params of the module. | | [setPreselectedFilters](./x-components.facetsmutations.setpreselectedfilters.md) | | (filters: RawFilter\[\]) =&gt; void | Adds a list of filters to the [preselectedFilters](./x-components.facetsstate.preselectedfilters.md) record. | | [setStickyFilter](./x-components.facetsmutations.setstickyfilter.md) | | (filter: RawFilter) =&gt; void | Adds the filter to the [sticky filters](./x-components.facetsstate.stickyfilters.md) record. |