useAutocomplete()

This is the React InstantSearch v7 documentation. React InstantSearch v7 is the latest version of React InstantSearch and the stable version of React InstantSearch Hooks.

If you were using React InstantSearch v6, you can upgrade to v7.

If you were using React InstantSearch Hooks, you can still use the React InstantSearch v7 documentation, but you should check the upgrade guide for necessary changes.

If you want to keep using React InstantSearch 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 available in React InstantSearch, but you can make a custom version with useConnector() and connectAutocomplete.

Guides Create your own React InstantSearch widgets

What is Autocomplete?

Integrate Autocomplete with React InstantSearch

Using Autocomplete with React

API reference React

InstantSearch.js

React

See code examples

Examples

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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 */}</>;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
import { useConnector } from 'react-instantsearch';
import connectAutocomplete from 'instantsearch.js/es/connectors/autocomplete/connectAutocomplete';

import type {
  AutocompleteConnectorParams,
  AutocompleteWidgetDescription,
} from 'instantsearch.js/es/connectors/autocomplete/connectAutocomplete';

export type UseAutocompleteProps = AutocompleteConnectorParams;

// Connect the InstantSearch.js `connectAutocomplete` connector to your component
export function useAutocomplete(props?: UseAutocompleteProps) {
  return useConnector<AutocompleteConnectorParams, AutocompleteWidgetDescription>(
    connectAutocomplete,
    props
  );
}

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

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

Did you find this page helpful?

useAutocomplete()

About this Hook

Examples

On this page