ais-index

About this widget

This widget lets you apply widgets to a specific index. It’s useful when you want to build an interface that targets multiple indices.

This pattern is also called “Federated Search”, more information can be found in the guides dedicated to it.

The position of index in the widgets tree impacts which search parameters apply. Search parameters that widgets create are forwarded to their child index widgets.

1
2
3
4
5
6
7
8
<ais-instant-search index-name="instant_search">
  <ais-search-box />
  <ais-hits />
  <ais-index index-name="media">
    <!-- The index inherits from the parent's `searchBox` search parameters -->
    <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-boxes or two ais-refinement-lists 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 index-name="instant_search">
  <ais-search-box />
  <ais-hits />
  <ais-index index-name="media">
    <!-- The index does not inherit from the parent's `searchBox` search parameters -->
    <ais-search-box />
    <ais-hits />
  </ais-index>
</ais-instant-search>

The same rule applies when you nest multiple index widgets.

Examples

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