useVoiceSearch()

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 lets users perform voice-based queries.

The useVoiceSearch Hook isn’t available in React InstantSearch, but you can make a custom version with useConnector() and connectVoiceSearch.

See code examples

Examples

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import { useConnector } from 'react-instantsearch';
import connectVoiceSearch from 'instantsearch.js/es/connectors/voice-search/connectVoiceSearch';

export function useVoiceSearch(props) {
  return useConnector(connectVoiceSearch, props);
}

export function VoiceSearch(props) {
  const {
    isBrowserSupported,
    isListening,
    toggleListening,
    voiceListeningState,
  } = useVoiceSearch(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
25
26
27
import { useConnector } from 'react-instantsearch';
import connectVoiceSearch from 'instantsearch.js/es/connectors/voice-search/connectVoiceSearch';

import type {
  VoiceSearchConnectorParams,
  VoiceSearchWidgetDescription,
} from 'instantsearch.js/es/connectors/voice-search/connectVoiceSearch';

export type UseVoiceSearchProps = VoiceSearchConnectorParams;

export function useVoiceSearch(props?: UseVoiceSearchProps) {
  return useConnector<VoiceSearchConnectorParams, VoiceSearchWidgetDescription>(
    connectVoiceSearch,
    props
  );
}

export function VoiceSearch(props: UseVoiceSearchProps) {
  const {
    isBrowserSupported,
    isListening,
    toggleListening,
    voiceListeningState,
  } = useVoiceSearch(props);

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

Did you find this page helpful?

useVoiceSearch()

About this Hook

Examples

On this page