Index

Scopes a group of widgets to a specific index in multi-index search interfaces.

This is the React InstantSearch v7 documentation. If you’re upgrading from v6, see the upgrade guide. If you were using React InstantSearch Hooks, this v7 documentation applies—just check for necessary changes. To continue using v6, you can find the archived documentation.

Signature

<Index
  // Required unless isolated is true
  indexName={string}
  // Optional props
  indexId={string}
  isolated={boolean}
/>

Import

JavaScript

import { Index } from "react-instantsearch";

See this widget in action

Preview this widget and its behavior.

About this widget

<Index> is the provider component for an Algolia index.

It’s useful when building interfaces that target multiple indices such as federated searches.

The position of <Index> in the widget tree affects which search parameters apply. Widgets that create search parameters forward them to their children <Index> widgets.

Examples

JavaScript

import React from "react";
import { liteClient as algoliasearch } from "algoliasearch/lite";
import { InstantSearch, Index } from "react-instantsearch";

const searchClient = algoliasearch("YourApplicationID", "YourSearchOnlyAPIKey");

function App() {
  return (
    <InstantSearch indexName="instant_search" searchClient={searchClient}>
      {/* Widgets */}
      <Index indexName="instant_search_demo_query_suggestions">
        {/* Widgets */}
      </Index>
    </InstantSearch>
  );
}

Props

indexName · string

The main index to search into. This prop is required unless isolated is true.

JavaScript

<Index indexName="instant_search">{/* Widgets */}</Index>;

indexId · string

An identifier for the <Index> widget.

Providing an indexId lets different <Index widgets target the same Algolia index. It’s helpful for routing. It lets you find the refinements that match an <Index> widget.

JavaScript

<Index
  // ...
  indexId="instant_search"
>
  {/* Widgets */}
</Index>;

isolated · boolean · default: false

By default, an <Index> component is included in the main InstantSearch request. When isolated is true, the component performs its own search requests instead.

When isolated is true, the index:

• Searches separately instead of being included in the main search request.
• Isn’t included in the URL or UI state.
• Isn’t included in server-side rendering.

You can omit indexName when isolated is true. EXPERIMENTAL_isolated is a deprecated alias. Use isolated instead.

JavaScript

<Index indexName="instant_search" isolated>
  {/* Widgets */}
</Index>