@coveo/headless-react
    Preparing search index...

    Interface FacetOptionsActionCreators

    The facetOptions action creators.

    interface FacetOptionsActionCreators {
        disableFacet(facetId: string): { payload: string; type: string };
        enableFacet(facetId: string): { payload: string; type: string };
        updateFacetOptions(
            payload: UpdateFacetOptionsActionCreatorPayload,
        ): { payload: UpdateFacetOptionsActionCreatorPayload; type: string };
    }
    Index

    Methods

    • Disables a facet. I.e., prevents it from filtering results.

      Parameters

      • facetId: string

        The unique identifier of the facet (e.g., "1").

      Returns { payload: string; type: string }

      A dispatchable action.

    • Enables a facet. I.e., undoes the effects of disable.

      Parameters

      • facetId: string

        The unique identifier of the facet (e.g., "abcd").

      Returns { payload: string; type: string }

      A dispatchable action.