Signature
Import
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. The position ofindex
in the widgets tree affects which search parameters apply.
Widgets that create search parameters forward them to their child index
widgets.
JavaScript
searchBox
widgets
or two refinementList
widgets on the same attribute.
In that case, the latter takes precedence and overrides the search parameters.
JavaScript
index
widgets.
Examples
JavaScript
Options
The index to search into.
JavaScript
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
Methods
addWidgets
Adds widget(s) to the index.
JavaScript
removeWidgets
Removes widget(s) from the
index
widget. To be properly removed, the widget instances you pass must have a dispose()
method.JavaScript