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

    Interface NumericFacetSetActionCreators

    The numeric facet action creators.

    interface NumericFacetSetActionCreators {
        deselectAllNumericFacetValues(
            facetId: string,
        ): { payload: string; type: string };
        registerNumericFacet(
            payload: RegisterNumericFacetActionCreatorPayload,
        ): { payload: RegisterNumericFacetActionCreatorPayload; type: string };
        toggleExcludeNumericFacetValue(
            payload: ToggleSelectNumericFacetValueActionCreatorPayload,
        ): {
            payload: ToggleSelectNumericFacetValueActionCreatorPayload;
            type: string;
        };
        toggleSelectNumericFacetValue(
            payload: ToggleSelectNumericFacetValueActionCreatorPayload,
        ): {
            payload: ToggleSelectNumericFacetValueActionCreatorPayload;
            type: string;
        };
        updateNumericFacetSortCriterion(
            payload: UpdateNumericFacetSortCriterionActionCreatorPayload,
        ): {
            payload: UpdateNumericFacetSortCriterionActionCreatorPayload;
            type: string;
        };
        updateNumericFacetValues(
            payload: UpdateNumericFacetValuesActionCreatorPayload,
        ): { payload: UpdateNumericFacetValuesActionCreatorPayload; type: string };
    }
    Index

    Methods

    deselectAllNumericFacetValues registerNumericFacet toggleExcludeNumericFacetValue toggleSelectNumericFacetValue updateNumericFacetSortCriterion updateNumericFacetValues

    Methods

    • Deselects all values of a numeric facet.

      Parameters

      • facetId: string

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

      Returns { payload: string; type: string }

      A dispatchable action.

    Settings

    Member Visibility

    On This Page

    Methods