> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# useVoiceSearch

> React Hook for providing voice-based search input.

<div className="not-prose algolia-flavor-switcher">
  <div className="afs-dropdown">
    <div className="afs-trigger" role="button" tabIndex="0" aria-haspopup="listbox">
      <span className="afs-current">React</span>

      <svg className="afs-chevron lucide lucide-chevron-down" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
        <path d="m6 9 6 6 6-6" />
      </svg>
    </div>

    <ul className="afs-menu" role="listbox">
      <li role="option" aria-selected="false"><a className="afs-option" href="/doc/api-reference/widgets/voice-search/js"><span className="afs-option-name">JavaScript</span><span className="afs-option-lib">InstantSearch.js</span></a></li>
      <li role="option" aria-selected="true"><a className="afs-option is-current" href="/doc/api-reference/widgets/voice-search/react"><span className="afs-option-name">React</span><span className="afs-option-lib">React InstantSearch</span></a></li>
      <li role="option" aria-selected="false"><a className="afs-option" href="/doc/api-reference/widgets/voice-search/vue"><span className="afs-option-name">Vue</span><span className="afs-option-lib">Vue InstantSearch</span></a></li>
    </ul>
  </div>
</div>

<Note>
  This is the **React InstantSearch v7** documentation.
  If you're upgrading from v6, see the [upgrade guide](/doc/guides/building-search-ui/upgrade-guides/react/#migrate-from-react-instantsearch-v6-to-react-instantsearch-v7).
  If you were using React InstantSearch Hooks,
  this v7 documentation applies—just check for [necessary changes](/doc/guides/building-search-ui/upgrade-guides/react/#migrate-from-react-instantsearch-hooks-to-react-instantsearch-v7).
  To continue using v6, you can find the [archived documentation](https://algolia.com/old-docs/deprecated/instantsearch/react/v6/api-reference/instantsearch/).
</Note>

## About this Hook

This Hook lets users perform voice-based queries.

The `useVoiceSearch` Hook isn't part of React InstantSearch,
but you can make a custom version with [`useConnector`](/doc/api-reference/widgets/connector/react)
and [`connectVoiceSearch`](/doc/api-reference/widgets/voice-search/js#customize-the-ui-with-connectvoicesearch).

## Examples

<CodeGroup>
  ```jsx JavaScript theme={"system"}
  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 */}</>;
  }
  ```

  ```tsx TypeScript theme={"system"}
  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 */}</>;
  }
  ```
</CodeGroup>