useAutocomplete

React Hook for creating an autocomplete component.

This is the React InstantSearch v7 documentation. If you’re upgrading from v6, see the upgrade guide. If you were using React InstantSearch Hooks, this v7 documentation applies—just check for necessary changes. To continue using v6, you can find the archived documentation.

About this Hook

This Hook provides access to all indices of your InstantSearch instance.

The useAutocomplete Hook isn’t part of React InstantSearch, but you can make a custom version with useConnector and connectAutocomplete.

See also:

• Integrate Autocomplete with React InstantSearch
• Create your own React InstantSearch widgets

Examples

JavaScript

import { useConnector } from "react-instantsearch";
import connectAutocomplete from "instantsearch.js/es/connectors/autocomplete/connectAutocomplete";

// Connect the InstantSearch.js `connectAutocomplete` connector to your component
export function useAutocomplete(props) {
  return useConnector(connectAutocomplete, props);
}

// The props you can use in your component to interact with Autocomplete
export function Autocomplete(props) {
  const { indices, currentRefinement, refine } = useAutocomplete(props);

  return <>{/* Your JSX */}</>;
}