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

# React InstantSearch

> Overview of React InstantSearch widgets.

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

## Basics

|                                                                          |                                                                                                                                                           |
| ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`InstantSearch`](/doc/api-reference/widgets/instantsearch/react)        | The root wrapper component for all widgets and Hooks.                                                                                                     |
| [`useInstantSearch`](/doc/api-reference/widgets/use-instantsearch/react) | React Hook to access the InstantSearch API.                                                                                                               |
| [`Index`](/doc/api-reference/widgets/index-widget/react)                 | The provider component for an Algolia index.                                                                                                              |
| [`SearchBox`](/doc/api-reference/widgets/search-box/react)               | A widget to display a search box.                                                                                                                         |
| [`Configure`](/doc/api-reference/widgets/configure/react)                | A widget to forward search parameters to Algolia.                                                                                                         |
| [`Autocomplete`](/doc/api-reference/widgets/autocomplete/react)          | A widget that shows query results as you type in a search box.                                                                                            |
| [`Chat`](/doc/api-reference/widgets/chat/react)                          | 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/react)           | A widget to display a button that opens the [`Chat`](/doc/api-reference/widgets/chat/react) widget's overlay.                                             |
| [`Feeds`](/doc/api-reference/widgets/feeds/react)                        | A component to display multiple independent result sets from a [multifeed composition](/doc/guides/managing-results/compositions/multifeed-compositions). |
| [`useVoiceSearch`](/doc/api-reference/widgets/voice-search/react)        | React Hook to use a voice search connector.                                                                                                               |
| [`insights`](/doc/api-reference/widgets/insights/react)                  | 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/react)              | With the middleware API, you can inject logic into InstantSearch.js.                                                                                      |
| [`renderState`](/doc/api-reference/widgets/render-state/react)           | The `renderState` provides access to all the data to render the widgets, including the methods to refine the search.                                      |
| [`useConnector`](/doc/api-reference/widgets/connector/react)             | React Hook to use an InstantSearch connector.                                                                                                             |

## Results

|                                                                  |                                                                                                |
| ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| [`Hits`](/doc/api-reference/widgets/hits/react)                  | A widget to display a list of search results.                                                  |
| [`InfiniteHits`](/doc/api-reference/widgets/infinite-hits/react) | A widget to display an infinite list of results.                                               |
| [`Highlight`](/doc/api-reference/widgets/highlight/react)        | Highlighting visually emphasizes matching terms in your search results to help them stand out. |
| [`Snippet`](/doc/api-reference/widgets/snippet/react)            | A widget that displays attributes in your search results in a shorter form (a snippet).        |

## Recommendations

|                                                                                           |                                                                     |
| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| [`FrequentlyBoughtTogether`](/doc/api-reference/widgets/frequently-bought-together/react) | A widget to display a list of frequently bought together items.     |
| [`RelatedProducts`](/doc/api-reference/widgets/related-products/react)                    | A widget to display a list of related products and related content. |
| [`TrendingItems`](/doc/api-reference/widgets/trending-items/react)                        | A widget to display a list of trending items.                       |
| [`TrendingFacets`](/doc/api-reference/widgets/trending-facets/react)                      | A widget to display a list of trending facets.                      |
| [`LookingSimilar`](/doc/api-reference/widgets/looking-similar/react)                      | A widget to display a list of visually similar products.            |

## Refinements

|                                                                                 |                                                                                                                                   |
| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| [`RefinementList`](/doc/api-reference/widgets/refinement-list/react)            | A widget to display multi-select facets.                                                                                          |
| [`ColorRefinementList`](/doc/api-reference/widgets/color-refinement-list/react) | 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/react)             | A widget to conditionally render other widgets based on the index settings.                                                       |
| [`HierarchicalMenu`](/doc/api-reference/widgets/hierarchical-menu/react)        | Widget that displays a hierarchical menu.                                                                                         |
| [`useRange`](/doc/api-reference/widgets/range-slider/react)                     | React Hook to filter search results within a numeric range.                                                                       |
| [`Menu`](/doc/api-reference/widgets/menu/react)                                 | A widget to display a menu to let users choose a single value.                                                                    |
| [`CurrentRefinements`](/doc/api-reference/widgets/current-refinements/react)    | A widget to display the list of active refinements in the search.                                                                 |
| [`RangeInput`](/doc/api-reference/widgets/range-input/react)                    | A widget to select a numerical range using minimum and maximum inputs.                                                            |
| [`MenuSelect`](/doc/api-reference/widgets/menu-select/react)                    | A widget to use a menu select connector.                                                                                          |
| [`ToggleRefinement`](/doc/api-reference/widgets/toggle-refinement/react)        | A widget to provide an on/off filter.                                                                                             |
| [`useNumericMenu`](/doc/api-reference/widgets/numeric-menu/react)               | React Hook that shows a list of numeric filters that are pre-configured when creating the widget.                                 |
| [`useRatingMenu`](/doc/api-reference/widgets/rating-menu/react)                 | React Hook to use a rating menu connector.                                                                                        |
| [`ClearRefinements`](/doc/api-reference/widgets/clear-refinements/react)        | A widget to reset the active refinements of the search.                                                                           |

## Pagination

|                                                                 |                                                                                 |
| --------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| [`Pagination`](/doc/api-reference/widgets/pagination/react)     | A widget to display a pagination to browse pages.                               |
| [`HitsPerPage`](/doc/api-reference/widgets/hits-per-page/react) | A widget to display a menu of options to change the number of results per page. |

## Metadata

|                                                                                   |                                                                                                                               |
| --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| [`Breadcrumb`](/doc/api-reference/widgets/breadcrumb/react)                       | A widget to display navigation links to see where the current page is in relation to the facet's hierarchy.                   |
| [`Stats`](/doc/api-reference/widgets/stats/react)                                 | A widget that displays the total number of matching hits and the time it took to get them (time spent in the Algolia server). |
| [`PoweredBy`](/doc/api-reference/widgets/powered-by/react)                        | A widget to display the Algolia logo to redirect to the Algolia website.                                                      |
| [`StateResults`](/doc/api-reference/widgets/state-results/react)                  | A widget for accessing the state and results of InstantSearch.                                                                |
| [`QueryRulesCustomData`](/doc/api-reference/widgets/query-rule-custom-data/react) | A widget to display custom data from rules.                                                                                   |
| [`QueryRuleContext`](/doc/api-reference/widgets/query-rule-context/react)         | A widget to set Rule contexts without rendering anything.                                                                     |
| [`useQueryRules`](/doc/api-reference/widgets/query-rules/react)                   | React Hook to set custom Rule contexts and display custom data from Rules.                                                    |

## Sorting

|                                                                     |                                              |
| ------------------------------------------------------------------- | -------------------------------------------- |
| [`SortBy`](/doc/api-reference/widgets/sort-by/react)                | A widget to sort by specified indices.       |
| [`useRelevantSort`](/doc/api-reference/widgets/relevant-sort/react) | React Hook to use a relevant sort connector. |

## Geo search

|                                                               |                                                            |
| ------------------------------------------------------------- | ---------------------------------------------------------- |
| [`useGeoSearch`](/doc/api-reference/widgets/geo-search/react) | A React Hook that displays search results on a Google Map. |

## Routing

|                                                                                        |                                                                      |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| [`simple`](/doc/api-reference/widgets/simple-state-mapping/react)                      | A state mapping used by default routing.                             |
| [`history`](/doc/api-reference/widgets/history-router/react)                           | A router used by default routing.                                    |
| [`uiState`](/doc/api-reference/widgets/ui-state/react)                                 | An object that represents a search UI state.                         |
| [`createInstantSearchRouterNext`](/doc/api-reference/widgets/instantsearch-next/react) | The function that creates a Next.js-compatible InstantSearch router. |

## Server

|                                                                             |                                                                                     |
| --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| [`InstantSearchSSRProvider`](/doc/api-reference/widgets/ssr-provider/react) | The provider component that forwards the server state to `InstantSearch`.           |
| [`getServerState`](/doc/api-reference/widgets/server-state/react)           | The function that retrieves the server state to pass to `InstantSearchSSRProvider`. |
