InstantSearch / React / V6 / API reference

Index | React InstantSearch V6 (Deprecated)

Deprecated content
This documentation is for a deprecated version of React InstantSearch. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of React InstantSearch for up-to-date information.

Signature

Signature
<Index
  indexName={string}
  // Optional parameters
  indexId={string}
/>

About this widget

Index is the component that allows you to apply widgets to a dedicated index. This is useful if you want to build an interface that targets multiple indices.

You can learn more about this pattern, called “Federated Search”, in the guides on multi-index search.

The position of index in the widgets tree impacts which search parameters apply. Widgets that create search parameters forward them to their child index widgets.

Examples

1
2
3
4
5
import { Index } from 'react-instantsearch-dom';

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

Props

indexName

Required
Type: string

The index to search into.

1
2
3
<Index indexName="instant_search">
  {/* Widgets */}
</Index>

indexId

Optional
Type: string

An identifier for the index. Providing an indexId allows multiple Index to target the same index as if they were two different indices. If multiple Index share the same indexId, the state will be shared; meaning that anything applied to one Index like a refinement will also be applied to the other ones sharing the same id.

1
2
3
4
5
6
<Index
  // ...
  indexId="instant_search_one"
>
  {/* Widgets */}
</Index>
Did you find this page helpful?