> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.
# index
> Scopes a group of widgets to a specific index in multi-index search interfaces.
```ts Signature theme={"system"}
index({
indexName: string,
// Optional parameters
indexId?: string,
});
```
## Import
```js Package manager theme={"system"}
import { index } from "instantsearch.js/es/widgets";
```
```js CDN theme={"system"}
const { index } = instantsearch.widgets;
// or directly use instantsearch.widgets.index()
```
Preview this widget and its behavior.
## About this widget
This widget lets you apply widgets to a specific index.
It's useful when building interfaces that target multiple indices such as [federated searches](/doc/guides/building-search-ui/ui-and-ux-patterns/multi-index-search/js).
The position of `index` in the widgets tree affects which search parameters apply.
Widgets that create search parameters forward them to their child `index` widgets.
```js JavaScript icon=code theme={"system"}
search.addWidgets([
searchBox(),
hits(),
index({ indexName: "instant_search" }).addWidgets([
// The index inherits from the parent's `searchBox` search parameters
hits(),
]),
]);
```
The only exception to this rule is when two widgets own the same part of your UI state,
like two [`searchBox`](/doc/api-reference/widgets/search-box/js) widgets
or two [`refinementList`](/doc/api-reference/widgets/refinement-list/js) widgets on the same attribute.
In that case, the latter takes precedence and overrides the search parameters.
```js JavaScript icon=code theme={"system"}
search.addWidgets([
searchBox(),
hits(),
index({ indexName: "instant_search" }).addWidgets([
// The index does not inherit from the parent's `searchBox` search parameters
searchBox(),
hits(),
]),
]);
```
The same rule applies when you nest multiple `index` widgets.
## Examples
```js JavaScript icon=code theme={"system"}
index({ indexName: "instant_search" }).addWidgets([
// Add widgets
// ...
]);
```
## Options
The index to search into.
```js JavaScript icon=code theme={"system"}
index({
indexName: "instant_search",
});
```
An identifier for the `index` widget.
Providing an `indexId` lets different `index` widgets target the same Algolia index.
It's helpful for [`routing`](/doc/api-reference/widgets/instantsearch/js#param-routing).
It lets you find the refinements that match an `index` widget.
```js JavaScript icon=code theme={"system"}
index({
// ...
indexId: "instant_search_one",
});
```
## Methods
Adds widget(s) to the index.
```js JavaScript icon=code theme={"system"}
const index = index({
indexName: "instant_search",
});
const searchBox = searchBox({
// ...
});
const hits = hits({
// ...
});
index.addWidgets([searchBox, hits]);
```
Removes widget(s) from the `index` widget. To be properly removed, the widget instances you pass must have a `dispose()` method.
```js JavaScript icon=code theme={"system"}
const index = index({
indexName: "instant_search",
});
const searchBox = searchBox({
// ...
});
const hits = hits({
// ...
});
index.removeWidgets([searchBox, hits]);
```