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

    Type Alias CoreCommerceFacet<ValueRequest, ValueResponse>

    CoreCommerceFacet: Pick<
        CoreFacet,
        "deselectAll"
        | "showLessValues"
        | "showMoreValues"
        | "subscribe",
    > & {
        isValueExcluded(value: ValueResponse): boolean;
        isValueSelected(value: ValueResponse): boolean;
        toggleExclude(selection: ValueRequest): void;
        toggleSelect(selection: ValueRequest): void;
        toggleSingleExclude(selection: ValueRequest): void;
        toggleSingleSelect(selection: ValueRequest): void;
    }

    Type Parameters

    Type declaration

    • isValueExcluded: function
      • Whether the specified facet value is excluded.

        Parameters

        Returns boolean

    • isValueSelected: function
      • Whether the specified facet value is selected.

        Parameters

        Returns boolean

    • toggleExclude: function
      • Toggles exclusion of the specified facet value.

        Parameters

        Returns void

    • toggleSelect: function
      • Toggles selection of the specified facet value.

        Parameters

        Returns void

    • toggleSingleExclude: function
      • Toggles exclusion of the specified facet value, deselecting all others.

        Parameters

        Returns void

    • toggleSingleSelect: function
      • Toggles selection of the specified facet value, deselecting all others.

        Parameters

        Returns void