-
Search Actions
- AdvancedSearchQuery
- Breadcrumb
- CategoryFacetSet
- ClickAnalytics
- Configuration
- Context
- DateFacetSet
- Debug
- DictionaryFieldContext
- DidYouMean
- FacetOptions
- FacetSet
- Field
- Folding
- GenericAnalytics
- History
- NumericFacetSet
- Pagination
- Pipeline
- Query
- QuerySet
- QuerySuggest
- QuestionAnswering
- Search
- SearchAnalytics
- SearchConfiguration
- SearchHub
- SortCriteria
- StandaloneSearchBoxSet
- StaticFilterSet
FacetOptionsActions
The facetOptions action creators.
See Dispatch Actions.
Loader Function
loadFacetOptionsActions
Loads the facetOptions reducer and returns possible action creators.
Parameters
-
engine:
SearchEngineThe headless engine.
Returns FacetOptionsActionCreators: The facetOptions action creators.
FacetOptionsActionCreators
disableFacet
Disables a facet. I.e., prevents it from filtering results.
Parameters
-
facetId:
stringThe unique identifier of the facet (e.g., "1").
Returns PayloadAction<string>: A dispatchable action.
enableFacet
Enables a facet. I.e., undoes the effects of disable.
Parameters
-
facetId:
stringThe unique identifier of the facet (e.g., "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:
UpdateFacetOptionsActionCreatorPayloadThe action creator payload.
Returns PayloadAction<UpdateFacetOptionsActionCreatorPayload>: A dispatchable action.
Related Types
UpdateFacetOptionsActionCreatorPayload
Properties
-
freezeFacetOrder?:
booleanWhether facets should be returned in the same order they were requested.