ais-index

About this widget

This widget lets you apply widgets to a specific index. This is useful when 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.

1
2
3
4
5
6
7
8
<ais-instant-search>
  <ais-search-box></ais-search-box>
  <ais-hits></ais-hits>
  <ais-index indexName="media">
    <!-- The index inherits from the parent's `searchBox` search parameters -->
    <ais-hits></ais-hits>
  </ais-index>
</ais-instant-search>

The only exception to this rule is when two widgets own the same part of your UI state, like two ais-search-box widgets or two ais-refinement-list widgets on the same attribute. In that case, the latter takes precedence and overrides the search parameters.

1
2
3
4
5
6
7
8
9
<ais-instant-search>
  <ais-search-box></ais-search-box>
  <ais-hits></ais-hits>
  <ais-index indexName="media">
    <!-- The index does not inherit from the parent's `searchBox` search parameters -->
    <ais-search-box></ais-search-box>
    <ais-hits></ais-hits>
  </ais-index>
</ais-instant-search>

The same rule applies when you nest multiple index widgets.

Examples

1
2
3
<ais-index indexName="instant_search">
  <!-- Add widgets -->
</ais-index>