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

    Interface RegisterFacetActionCreatorPayload

    interface RegisterFacetActionCreatorPayload {
        activeTab?: string;
        allowedValues?: { type: "simple"; values: string[] };
        customSort?: string[];
        facetId: string;
        field: string;
        filterFacetCount?: boolean;
        injectionDepth?: number;
        numberOfValues?: number;
        resultsMustMatch?: FacetResultsMustMatch;
        sortCriteria?: FacetSortCriterion;
        tabs?: { excluded?: string[]; included?: string[] };
    }
    Index

    Properties

    activeTab? allowedValues? customSort? facetId field filterFacetCount? injectionDepth? numberOfValues? resultsMustMatch? sortCriteria? tabs?

    Properties

    activeTab?: string
    • This field is unused and should not be relied on. If you need the currently active tab, use the TabManager instead.

    This property will be removed in version 4.0.

    allowedValues?: { type: "simple"; values: string[] }

    Specifies an explicit list of allowedValues in the Search API request.

    If you specify a list of values for this option, the facet uses only these values (if they are available in the current result set).

    The maximum amount of allowed values is 25.

    Default value is undefined, and the facet uses all available values for its field in the current result set.

    customSort?: string[]

    Identifies the facet values that must appear at the top, in this order. This parameter can be used in conjunction with the sortCriteria parameter.

    Facet values not part of the customSort list will be sorted according to the sortCriteria.

    The maximum amount of custom sort values is 25.

    The default value is undefined, and the facet values will be sorted using only the sortCriteria.

    facetId: string

    A unique identifier for the facet.

    field: string

    The field from which to display values in the facet.

    filterFacetCount?: boolean

    Whether to exclude the parents of folded results when estimating the result count for each facet value.

    Note: Resulting count is only an estimation, in some cases this value could be incorrect.

    true

    injectionDepth?: number

    The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.

    Note: A high injectionDepth may negatively impact the facet request performance.

    Minimum: 0

    1000

    numberOfValues?: number

    The number of values to request for this facet. Also determines the number of additional values to request each time this facet is expanded, and the number of values to display when this facet is collapsed.

    Minimum: 1

    8

    resultsMustMatch?: FacetResultsMustMatch

    The criterion to use for specifying how results must match the selected facet values.

    atLeastOneValue

    sortCriteria?: FacetSortCriterion

    The criterion to use for sorting returned facet values.

    The sortCriteria option does not apply when making a facet search request. It is only used for sorting returned facet values during a regular Coveo search request.

    Learn more about sortCriteria values and the default behavior of specific facets in the Search API documentation.

    automatic

    tabs?: { excluded?: string[]; included?: string[] }

    The tabs on which the facet should be enabled or disabled.

    Settings

    Member Visibility
    In this article
    Properties