FacetOptionsActions
FacetOptionsActions
This is for:
DeveloperThe facetOptions action creators.
See Dispatch Actions.
Loader Function
loadFacetOptionsActions
Loads the facetOptions
reducer and returns possible action creators.
Parameters
-
engine:
SearchEngine
The headless engine.
Returns FacetOptionsActionCreators
: The facetOptions action creators.
FacetOptionsActionCreators
disableFacet
Disables a facet. In other words, prevents it from filtering results.
Parameters
-
facetId:
string
The unique identifier of the facet (for example, "1").
Returns PayloadAction<string>
: A dispatchable action.
enableFacet
Enables a facet. In other words, undoes the effects of disable
.
Parameters
-
facetId:
string
The unique identifier of the facet (for example, "abcd").
Returns PayloadAction<string>
: A dispatchable action.
updateFacetOptions
Updates options that affect facet reordering. For more information, refer to the documentation on query parameters.
Parameters
-
payload:
UpdateFacetOptionsActionCreatorPayload
The action creator payload.
Returns PayloadAction<UpdateFacetOptionsActionCreatorPayload>
: A dispatchable action.
Related Types
UpdateFacetOptionsActionCreatorPayload
Properties
-
freezeFacetOrder?:
boolean
Whether facets should be returned in the same order they were requested.