UNPKG

@empathyco/x-components

Version:
306 lines (131 loc) • 4.61 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [FacetsXEvents](./x-components.facetsxevents.md) ## FacetsXEvents interface Dictionary of the events of Facets XModule, where each key is the event name, and the value is the event payload type or `void` if it has no payload. **Signature:** ```typescript export interface FacetsXEvents ``` ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> [FacetsGroupChanged](./x-components.facetsxevents.facetsgroupchanged.md) </td><td> </td><td> [FacetsGroup](./x-components.facetsgroup.md) </td><td> The facets from a group have changed Payload: The group id and the new list of facets for it. </td></tr> <tr><td> [FacetsGroupProvided](./x-components.facetsxevents.facetsgroupprovided.md) </td><td> </td><td> [FacetsGroup](./x-components.facetsgroup.md) </td><td> A new set of facets for the group has been provided. Payload: The group id and the new list of facets for it. </td></tr> <tr><td> [FacetsQueryChanged](./x-components.facetsxevents.facetsquerychanged.md) </td><td> </td><td> string </td><td> The query used in the module has changed. Payload: The facets query. </td></tr> <tr><td> [PreselectedFiltersProvided](./x-components.facetsxevents.preselectedfiltersprovided.md) </td><td> </td><td> RawFilter\[\] </td><td> The selected filters provided in the [SnippetConfig](./x-components.snippetconfig.md)<!-- -->. Payload: the raw filters. </td></tr> <tr><td> [SelectedFiltersChanged](./x-components.facetsxevents.selectedfilterschanged.md) </td><td> </td><td> Filter\[\] </td><td> The selected filters have changed. Payload: the new list of selected filters. </td></tr> <tr><td> [SelectedFiltersForRequestChanged](./x-components.facetsxevents.selectedfiltersforrequestchanged.md) </td><td> </td><td> Filter\[\] </td><td> The selected filters that conform to the filters for request strategy have changed. Payload: the new list of selected filters. </td></tr> <tr><td> [UserChangedSelectedFilters](./x-components.facetsxevents.userchangedselectedfilters.md) </td><td> </td><td> Filter\[\] </td><td> A user action has changed the selected filters. Payload: The new list of selected filters. </td></tr> <tr><td> [UserClickedAFilter](./x-components.facetsxevents.userclickedafilter.md) </td><td> </td><td> Filter </td><td> The user has clicked any kind of filter. Payload: The clicked filter. </td></tr> <tr><td> [UserClickedAHierarchicalFilter](./x-components.facetsxevents.userclickedahierarchicalfilter.md) </td><td> </td><td> HierarchicalFilter </td><td> The user has clicked a filter which is of hierarchical type. Payload: The clicked filter. </td></tr> <tr><td> [UserClickedAllFilter](./x-components.facetsxevents.userclickedallfilter.md) </td><td> </td><td> \[Facet\['id'\]\] </td><td> The user has clicked facet select all filters button. Payload: Facet id. </td></tr> <tr><td> [UserClickedANumberRangeFilter](./x-components.facetsxevents.userclickedanumberrangefilter.md) </td><td> </td><td> NumberRangeFilter </td><td> The user has clicked a filter which is of number range type. Payload: The clicked filter. </td></tr> <tr><td> [UserClickedASimpleFilter](./x-components.facetsxevents.userclickedasimplefilter.md) </td><td> </td><td> SimpleFilter </td><td> The user has clicked a filter which is of simple type. Payload: The clicked filter. </td></tr> <tr><td> [UserClickedClearAllFilters](./x-components.facetsxevents.userclickedclearallfilters.md) </td><td> </td><td> Array&lt;Facet\['id'\]&gt; \| undefined </td><td> The user has clicked button clear filters. Payload: array the facets ids. </td></tr> <tr><td> [UserModifiedEditableNumberRangeFilter](./x-components.facetsxevents.usermodifiededitablenumberrangefilter.md) </td><td> </td><td> EditableNumberRangeFilter </td><td> The user has modified a filter which is of editable number range filter type. Payload: An [EditableNumberRangeFilter](./x-components.editablenumberrangefilter.md)<!-- -->. </td></tr> </tbody></table>