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

# Install React InstantSearch

> Learn how to install React InstantSearch from npm and include it in your React app.

export const FlavorSwitcher = ({current, baseHref = "", options = [], label = "InstantSearch framework"}) => {
  if (options.length === 0) {
    return <div className="not-prose" role="alert" style={{
      margin: "0.25rem 0 1.5rem",
      padding: "0.75rem",
      border: "1px solid #f59e0b",
      borderRadius: "0.625rem",
      color: "inherit",
      fontSize: "0.875rem"
    }}>
        FlavorSwitcher requires at least one option.
      </div>;
  }
  const selected = options.find(option => option.value === current) ?? options[0];
  return <div className="not-prose mint-flavor-switcher">
      <style>{`
        .mint-flavor-switcher {
          --mfs-bg: #ffffff;
          --mfs-bg-hover: #f4f4f5;
          --mfs-bg-current: #eef2ff;
          --mfs-border: #d4d4d8;
          --mfs-fg: #18181b;
          --mfs-muted: #71717a;
          --mfs-accent: #4f46e5;
          position: relative;
          width: min(100%, 19rem);
          margin: 0.25rem 0 1.5rem;
          color: var(--mfs-fg);
          font-size: 0.875rem;
          line-height: 1.25rem;
        }

        .dark .mint-flavor-switcher {
          --mfs-bg: #18181b;
          --mfs-bg-hover: #27272a;
          --mfs-bg-current: #272747;
          --mfs-border: #3f3f46;
          --mfs-fg: #fafafa;
          --mfs-muted: #a1a1aa;
          --mfs-accent: #a5b4fc;
        }

        .mint-flavor-switcher details {
          position: relative;
        }

        .mint-flavor-switcher summary {
          display: flex;
          min-height: 2.75rem;
          box-sizing: border-box;
          align-items: center;
          justify-content: space-between;
          gap: 0.75rem;
          padding: 0.625rem 0.75rem;
          border: 1px solid var(--mfs-border);
          border-radius: 0.625rem;
          background: var(--mfs-bg);
          color: var(--mfs-fg);
          cursor: pointer;
          font-weight: 600;
          list-style: none;
          transition: border-color 150ms ease, box-shadow 150ms ease;
        }

        .mint-flavor-switcher summary::-webkit-details-marker {
          display: none;
        }

        .mint-flavor-switcher summary:hover {
          border-color: var(--mfs-accent);
        }

        .mint-flavor-switcher summary:focus-visible {
          outline: 2px solid var(--mfs-accent);
          outline-offset: 2px;
        }

        .mint-flavor-switcher__label {
          overflow: hidden;
          text-overflow: ellipsis;
          white-space: nowrap;
        }

        .mint-flavor-switcher__chevron {
          flex: none;
          transition: transform 150ms ease;
        }

        .mint-flavor-switcher details[open] .mint-flavor-switcher__chevron {
          transform: rotate(180deg);
        }

        .mint-flavor-switcher__menu {
          position: absolute;
          z-index: 50;
          top: calc(100% + 0.375rem);
          left: 0;
          width: 100%;
          box-sizing: border-box;
          margin: 0;
          padding: 0.375rem;
          border: 1px solid var(--mfs-border);
          border-radius: 0.625rem;
          background: var(--mfs-bg);
          box-shadow: 0 12px 30px rgb(0 0 0 / 16%);
          list-style: none;
        }

        .mint-flavor-switcher__menu li {
          margin: 0;
          padding: 0;
        }

        .mint-flavor-switcher__option {
          display: grid;
          gap: 0.125rem;
          padding: 0.625rem 0.75rem;
          border-radius: 0.4rem;
          color: var(--mfs-fg);
          text-decoration: none;
        }

        .mint-flavor-switcher__option:hover {
          background: var(--mfs-bg-hover);
        }

        .mint-flavor-switcher__option:focus-visible {
          outline: 2px solid var(--mfs-accent);
          outline-offset: -2px;
        }

        .mint-flavor-switcher__option[aria-current="page"] {
          background: var(--mfs-bg-current);
          color: var(--mfs-accent);
        }

        .mint-flavor-switcher__name {
          font-weight: 600;
        }

        .mint-flavor-switcher__description {
          color: var(--mfs-muted);
          font-size: 0.8125rem;
        }

        @media (prefers-reduced-motion: reduce) {
          .mint-flavor-switcher summary,
          .mint-flavor-switcher__chevron {
            transition: none;
          }
        }
      `}</style>

      <details>
        <summary aria-label={`${label}: ${selected.label}`}>
          <span className="mint-flavor-switcher__label">{selected.label}</span>
          <svg className="mint-flavor-switcher__chevron" width="18" height="18" 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>
        </summary>

        <ul className="mint-flavor-switcher__menu" aria-label={label}>
          {options.map(option => {
    const isCurrent = option.value === selected.value;
    const href = option.href ?? `${baseHref.replace(/\/$/, "")}/${encodeURIComponent(option.value)}`;
    return <li key={option.value}>
                <a className="mint-flavor-switcher__option" href={href} aria-current={isCurrent ? "page" : undefined}>
                  <span className="mint-flavor-switcher__name">
                    {option.label}
                  </span>
                  {option.description ? <span className="mint-flavor-switcher__description">
                      {option.description}
                    </span> : null}
                </a>
              </li>;
  })}
        </ul>
      </details>
    </div>;
};

<div className="mint-flavor-switcher-slot not-prose">
  <FlavorSwitcher
    current="react"
    baseHref="/doc/guides/building-search-ui/installation"
    options={[
{ value: "js", label: "JavaScript", description: "InstantSearch.js" },
{ value: "react", label: "React", description: "React InstantSearch" },
{ value: "vue", label: "Vue", description: "Vue InstantSearch" },
{ value: "ios", label: "iOS", description: "InstantSearch iOS" },
{ value: "android", label: "Android", description: "InstantSearch Android" },
{ value: "flutter", label: "Flutter", description: "Algolia for Flutter" },
]}
  />
</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>

Install React InstantSearch as an npm package or include it in your app with a CDN link.

React InstantSearch is composed of two separate packages:

* [`react-instantsearch`](https://www.npmjs.com/package/react-instantsearch) which exposes all UI widgets and re-exports all Hooks.
* [`react-instantsearch-core`](https://www.npmjs.com/package/react-instantsearch-core) which only exposes all Hooks. **You only need this package if you're using React InstantSearch with React Native.**

<Note>
  The code examples on this page use the React InstantSearch library with the `algoliasearch/lite` client,
  which is smaller but doesn't support indexing your data.
  To perform indexing operations, import the regular `algoliasearch` client.
</Note>

## Install React InstantSearch as an npm package

If you're using a package manager and a build tool, you can install React InstantSearch from npm.

For the web:

<CodeGroup>
  ```sh npm theme={"system"}
  npm install algoliasearch react-instantsearch
  ```

  ```sh yarn theme={"system"}
  yarn add algoliasearch react-instantsearch
  ```

  ```sh pnpm theme={"system"}
  pnpm add algoliasearch react-instantsearch
  ```
</CodeGroup>

For React Native:

<CodeGroup>
  ```sh npm theme={"system"}
  npm install algoliasearch react-instantsearch-core
  ```

  ```sh yarn theme={"system"}
  yarn add algoliasearch react-instantsearch-core
  ```

  ```sh pnpm theme={"system"}
  pnpm add algoliasearch react-instantsearch-core
  ```
</CodeGroup>

Then in your app, import the module:

```jsx React icon=code theme={"system"}
import { liteClient as algoliasearch } from "algoliasearch/lite";
import React from "react";
import { InstantSearch } from "react-instantsearch";

const appID = "ALGOLIA_APPLICATION_ID";
const apiKey = "ALGOLIA_SEARCH_API_KEY";
const indexName = "INDEX_NAME";

const searchClient = algoliasearch(appID, apiKey);

function App() {
	return (
		<InstantSearch searchClient={searchClient} indexName={indexName}>
		</InstantSearch>
	);
}
```

[`InstantSearch`](/doc/api-reference/widgets/instantsearch/react) is the root React InstantSearch component.
All widgets must be wrapped within it

<Check>
  In a production environment, [secure your API keys](/doc/guides/security/security-best-practices#secure-your-api-keys) as environment variables.
</Check>

## Include React InstantSearch with a CDN

If you don't use a package manager and a build tool,
you can include React InstantSearch directly from the [jsDelivr](https://www.jsdelivr.com) CDN.

```html HTML icon=code-xml theme={"system"}
<script
  src="https://cdn.jsdelivr.net/npm/react-instantsearch@7.40.0/dist/es/index.js"
  integrity="sha256-4rg36Ak9cPDb8fuYVFOAcCxz101mDGxYtI8o48jBiPc="
  crossorigin="anonymous"
></script>
```

```html HTML icon=code-xml theme={"system"}
<script
  src="https://cdn.jsdelivr.net/npm/algoliasearch@5.56.0/dist/lite/builds/browser.umd.js"
  integrity="sha256-FJAyZG3HT2S1oTZ1r2kwy0SBe/MC5MWzteI2GpIsKG0="
  crossorigin="anonymous"
></script>
```

You now have access to the `ReactInstantSearch` object on the global `window` object.

```jsx React icon=code theme={"system"}
const { liteClient: algoliasearch } = window["algoliasearch/lite"];
const { InstantSearch } = ReactInstantSearch;

const appID = "ALGOLIA_APPLICATION_ID";
const apiKey = "ALGOLIA_SEARCH_API_KEY";
const indexName = "INDEX_NAME";

const searchClient = algoliasearch(appID, apiKey);

function App() {
  return (
    <InstantSearch searchClient={searchClient} indexName={indexName}>
      {/* Add widgets here */}
    </InstantSearch>
  );
}
```

[`InstantSearch`](/doc/api-reference/widgets/instantsearch/react) is the root React InstantSearch component.
All widgets must be wrapped within it.

<Info>
  In a production environment, you should [secure your API keys](/doc/guides/security/security-best-practices#secure-your-api-keys) as environment variables.
</Info>

## Send click and conversion events

Capturing real-time user interactions as events gives you actionable insights from [click and conversion metrics](/doc/guides/search-analytics/concepts/metrics#click-through-rate),
and they help you increase your customer engagement and conversions.
Events are used to activate Algolia features and products like [NeuralSearch](/doc/guides/ai-relevance/neuralsearch/get-started),
[Dynamic Re-Ranking](/doc/guides/algolia-ai/re-ranking),
[Query Categorization](/doc/guides/algolia-ai/query-categorization),
[Recommend](/doc/guides/algolia-recommend/overview),
and [Personalization](/doc/guides/personalization/classic-personalization/what-is-personalization).

To send click and conversion events when users interact with your search UI, set the [`insights`](/doc/api-reference/widgets/instantsearch/react#param-insights) option to `true`.

## TypeScript support

These packages ship with TypeScript types:

* `react-instantsearch` (v7)
* `react-instantsearch-core` (v7)

The following packages don't ship with TypeScript types,
but have [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) definitions you can use:

* `react-instantsearch` (v6)
* `react-instantsearch-core` (v6)
* `react-instantsearch-dom` (v6)
* `react-instantsearch-native` (v6)

<Note>
  If you have issues when using them, [contact the DefinitelyTyped community](https://github.com/DefinitelyTyped/DefinitelyTyped/issues).
</Note>

The `react-instantsearch-dom-maps` package doesn't ship with TypeScript types and doesn't have any DefinitelyTyped definitions.

## Browser support

Algolia supports the last two versions of the major browsers:
Chrome, Edge, Firefox, Safari.

To support [Internet Explorer 11](https://wikipedia.org/wiki/Internet_Explorer_11) you need [polyfills](https://wikipedia.org/wiki/Polyfill_\(programming\)) for:
`Array.prototype.find`, `Array.prototype.includes`, `Promise`, `Object.entries`, and `Object.assign`.

<Note>
  The code samples in this documentation use a JavaScript syntax that isn't natively supported by older browsers like Internet Explorer 11.
  If your site needs to support older browsers, use a tool like [Babel](https://babeljs.io/repl) to make your code work in the browsers you target.
</Note>