FacetOptionsActions

Coveo Relevance Cloud Developer Headless Product Documentation

The 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. I.e., prevents it from filtering results.

Parameters

  • facetId: string

    The 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: string

    The 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

Returns PayloadAction<UpdateFacetOptionsActionCreatorPayload>: A dispatchable action.

UpdateFacetOptionsActionCreatorPayload

Properties

  • freezeFacetOrder?: boolean

    Whether facets should be returned in the same order they were requested.