> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# InstantSearch.js

> Overview of InstantSearch.js widgets.

To get started with InstantSearch.js,
see [What is InstantSearch?](/doc/guides/building-search-ui/what-is-instantsearch/js)

## Basics

|                                                                |                                                                                                                                                        |
| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`instantsearch`](/doc/api-reference/widgets/instantsearch/js) | The root wrapper component for all widgets.                                                                                                            |
| [`index`](/doc/api-reference/widgets/index-widget/js)          | This widget lets you apply widgets to a specific Algolia index.                                                                                        |
| [`searchBox`](/doc/api-reference/widgets/search-box/js)        | A widget to let users perform a text-based query.                                                                                                      |
| [`configure`](/doc/api-reference/widgets/configure/js)         | The widget lets you provide raw search parameters to the Algolia API without rendering anything.                                                       |
| [`panel`](/doc/api-reference/widgets/panel/js)                 | A widget that wraps other widgets in a consistent panel design. It also reacts when the widget can no longer refine.                                   |
| [`autocomplete`](/doc/api-reference/widgets/autocomplete/js)   | A widget that shows query results as you type in a search box.                                                                                         |
| [`chat`](/doc/api-reference/widgets/chat/js)                   | A widget to display a chat interface that interacts with a [generative AI assistant](/doc/guides/algolia-ai/agent-studio).                             |
| [`chatTrigger`](/doc/api-reference/widgets/chat-trigger/js)    | A widget to display a button that opens the [`chat`](/doc/api-reference/widgets/chat/js) widget's overlay.                                             |
| [`feeds`](/doc/api-reference/widgets/feeds/js)                 | A widget to display multiple independent result sets from a [multifeed composition](/doc/guides/managing-results/compositions/multifeed-compositions). |
| [`voiceSearch`](/doc/api-reference/widgets/voice-search/js)    | A widget to let users perform a voice-based query.                                                                                                     |
| [`insights`](/doc/api-reference/widgets/insights/js)           | A middleware to help set the user token for insights purposes, and send events from built-in and custom widgets.                                       |
| [`middleware`](/doc/api-reference/widgets/middleware/js)       | With the middleware API, you can inject logic into InstantSearch.js.                                                                                   |
| [`renderState`](/doc/api-reference/widgets/render-state/js)    | The `renderState` provides access to all the data to render the widgets, including the methods to refine the search.                                   |

## Results

|                                                                       |                                                                                                |
| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| [`hits`](/doc/api-reference/widgets/hits/js)                          | A widget to display a list of results.                                                         |
| [`infiniteHits`](/doc/api-reference/widgets/infinite-hits/js)         | A widget to display a list of results with a "Show more" button.                               |
| [`Highlight`](/doc/api-reference/widgets/highlight/js)                | Highlighting visually emphasizes matching terms in your search results to help them stand out. |
| [`ReverseHighlight`](/doc/api-reference/widgets/reverse-highlight/js) | A function that returns any attribute from a hit into its highlighted form, when relevant.     |
| [`Snippet`](/doc/api-reference/widgets/snippet/js)                    | A function that displays attributes in your search results in a shorter form (a snippet).      |
| [`ReverseSnippet`](/doc/api-reference/widgets/reverse-snippet/js)     | A function that returns any attribute from a hit into its snippeted form, when relevant.       |

## Recommendations

|                                                                                        |                                                                     |
| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| [`frequentlyBoughtTogether`](/doc/api-reference/widgets/frequently-bought-together/js) | A widget to display a list of frequently bought together items.     |
| [`relatedProducts`](/doc/api-reference/widgets/related-products/js)                    | A widget to display a list of related products and related content. |
| [`trendingItems`](/doc/api-reference/widgets/trending-items/js)                        | A widget to display a list of trending items.                       |
| [`trendingFacets`](/doc/api-reference/widgets/trending-facets/js)                      | A widget to display a list of trending facets.                      |
| [`lookingSimilar`](/doc/api-reference/widgets/looking-similar/js)                      | A widget to display a list of visually similar products.            |

## Refinements

|                                                                              |                                                                                                                                   |
| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| [`refinementList`](/doc/api-reference/widgets/refinement-list/js)            | One of the most common widgets you can find in a search UI. With this widget, users can filter the dataset based on facets.       |
| [`colorRefinementList`](/doc/api-reference/widgets/color-refinement-list/js) | A widget that filters results based on color facet values. It helps users quickly visualize the kind of color that products have. |
| [`dynamicWidgets`](/doc/api-reference/widgets/dynamic-facets/js)             | Widget to conditionally render other widgets based on the facet merchandising settings of the index.                              |
| [`hierarchicalMenu`](/doc/api-reference/widgets/hierarchical-menu/js)        | Widget that displays a hierarchical menu.                                                                                         |
| [`rangeSlider`](/doc/api-reference/widgets/range-slider/js)                  | A widget that provides a user-friendly way to filter the results, based on a single numeric range.                                |
| [`menu`](/doc/api-reference/widgets/menu/js)                                 | A widget that displays a menu that lets users choose a single value for a specific attribute.                                     |
| [`currentRefinements`](/doc/api-reference/widgets/current-refinements/js)    | A widget that displays a list of refinements applied to the search.                                                               |
| [`rangeInput`](/doc/api-reference/widgets/range-input/js)                    | A widget that allows a user to select a numeric range using a minimum and maximum input.                                          |
| [`menuSelect`](/doc/api-reference/widgets/menu-select/js)                    | A widget that allows a user to select a single value to refine in a drop-down menu.                                               |
| [`toggleRefinement`](/doc/api-reference/widgets/toggle-refinement/js)        | A widget that provides an on/off filtering feature based on an attribute value.                                                   |
| [`numericMenu`](/doc/api-reference/widgets/numeric-menu/js)                  | A widget that displays a list of numeric filters in a list. Those numeric filters are pre-configured with creating the widget.    |
| [`ratingMenu`](/doc/api-reference/widgets/rating-menu/js)                    | A widget that lets users refine search results by clicking on stars.                                                              |
| [`clearRefinements`](/doc/api-reference/widgets/clear-refinements/js)        | A widget that displays a button that lets users clean every refinement applied to the search.                                     |

## Pagination

|                                                              |                                                                                                        |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| [`pagination`](/doc/api-reference/widgets/pagination/js)     | A widget that displays a pagination system which lets users change the current page of search results. |
| [`hitsPerPage`](/doc/api-reference/widgets/hits-per-page/js) | A widget that displays a drop-down menu to let users change the number of displayed hits.              |

## Metadata

|                                                                               |                                                                                                                                            |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| [`breadcrumb`](/doc/api-reference/widgets/breadcrumb/js)                      | The breadcrumb widget is a secondary navigation scheme that lets users see where the current page is in relation to the facet's hierarchy. |
| [`stats`](/doc/api-reference/widgets/stats/js)                                | A widget that displays the total number of matching hits and the time it took to get them.                                                 |
| [`poweredBy`](/doc/api-reference/widgets/powered-by/js)                       | A widget to display the Algolia logo to redirect to the Algolia website.                                                                   |
| [`analytics`](/doc/api-reference/widgets/analytics/js)                        | A widget that pushes the current state of the search to the analytics platform of your choice.                                             |
| [`queryRuleCustomData`](/doc/api-reference/widgets/query-rule-custom-data/js) | A widget to display custom data from Rules.                                                                                                |
| [`queryRuleContext`](/doc/api-reference/widgets/query-rule-context/js)        | A widget to set Rule contexts without rendering anything.                                                                                  |

## Sorting

|                                                               |                                                                                                                                                                                                                           |
| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`sortBy`](/doc/api-reference/widgets/sort-by/js)             | A widget that displays a list of indices, allowing a user to change the way hits are sorted with replica indices.                                                                                                         |
| [`relevantSort`](/doc/api-reference/widgets/relevant-sort/js) | A widget that displays the current search mode when searching in a virtual replica index, and allows users to switch between Relevant and regular sorting, which is more exhaustive and can return less relevant results. |

## Geo search

|                                                         |                                                        |
| ------------------------------------------------------- | ------------------------------------------------------ |
| [`geoSearch`](/doc/api-reference/widgets/geo-search/js) | A widget that displays search results on a Google Map. |

## Routing

|                                                                           |                                                                       |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| [`simple`](/doc/api-reference/widgets/simple-state-mapping/js)            | A state mapping used by default routing.                              |
| [`singleIndex`](/doc/api-reference/widgets/single-index-state-mapping/js) | A state mapping that enables backward compatibility with version 3.x. |
| [`history`](/doc/api-reference/widgets/history-router/js)                 | A router used by default routing.                                     |
| [`uiState`](/doc/api-reference/widgets/ui-state/js)                       | An object that represents a search UI state.                          |
