useVoiceSearch()

About this Hook

The useVoiceSearch Hook isn’t currently available in React InstantSearch Hooks, but you can make it yourself using useConnector() along with connectVoiceSearch.

Refer to the connectVoiceSearch documentation for the full API reference.

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-hooks-web';
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-hooks-web';
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