getAlgoliaFacets

Retrieve Algolia facet hits from one or several indices with autocomplete-js.

The getAlgoliaFacets function lets you query facet hits from one or several Algolia indices.

Using getAlgoliaFacets lets Autocomplete batch all queries using the same search client into a single network call, and thus minimize search unit consumption. It also works out of the box with the components exposed in templates.

Example

JavaScript

import { liteClient as algoliasearch } from "algoliasearch/lite";
import { autocomplete, getAlgoliaFacets } from "@algolia/autocomplete-js";
const searchClient = algoliasearch(
  "latency",
  "6be0576ff61c053d5f9a3225e2a90f76",
);

autocomplete({
  // ...
  getSources({ query }) {
    return [
      {
        sourceId: "products",
        getItems({ query }) {
          return getAlgoliaFacets({
            searchClient,
            queries: [
              {
                indexName: "instant_search",
                facet: "categories",
                params: {
                  facetQuery: query,
                  maxFacetHits: 10,
                },
              },
            ],
          });
        },
        // ...
      },
    ];
  },
});

When using getAlgoliaFacets and getAlgoliaResults with the same search client in different sources or plugins, Autocomplete batches all queries into a single network call to Algolia. If you’re using the same search client for different sources or plugins, make sure to use the same instance to leverage the internal cache and batching mechanism.

Parameters

searchClient · SearchClient

The initialized Algolia search client.

queries · FacetQuery[]

The queries to search for.

Show FacetQuery properties

FacetQuery.indexName · string · required

The index name.

FacetQuery.facet · string · required

The attribute name to search facet values into.

The attribute must be declared in the attributesForFaceting index setting with the searchable() modifier.

FacetQuery.params · SearchForFacetValuesQueryParams

Algolia search for facet values parameters.

These are the default parameters. You can leave them as is and specify other parameters, or override them.

JSON

{
  "highlightPreTag": "__aa-highlight__",
  "highlightPostTag": "__/aa-highlight__"
}

If you override highlightPreTag and highlightPostTag, you won’t be able to use the built-in highlighting components such as Highlight.

FacetQuery.transformResponse · function

Type definition

(response: { 
  results: Array<SearchResponse<THit> | SearchForFacetValuesResponse>,
  hits: MaybeArray<Hit<THit>[]>,
  facetHits: MaybeArray<FacetHit[]>,
}) => MaybeArray<Hit<THit>[] | FacetHit[]>

The function to transform the Algolia response before passing it to the Autocomplete state. You have access to the full Algolia results, as well as the pre-computed hits and facet hits. This is useful to manipulate the hits, or store data from the results in the context.

This is the default implementation:

JavaScript

getAlgoliaFacets({
  // ...
  transformResponse({ facetHits }) {
    return facetHits;
  },
});

Returns

The function returns:

TypeScript

{
  searchClient: SearchClient;
  queries: MultipleQueriesQuery[];
  transformResponse: TransformResponse<THit>;
  execute: Execute<THit>;
}