> ## 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.

export const FlavorSwitcher = ({current, baseHref = "", options = [], label = "InstantSearch framework"}) => {
  if (options.length === 0) {
    return <div className="not-prose" role="alert" style={{
      margin: "0.25rem 0 1.5rem",
      padding: "0.75rem",
      border: "1px solid #f59e0b",
      borderRadius: "0.625rem",
      color: "inherit",
      fontSize: "0.875rem"
    }}>
        FlavorSwitcher requires at least one option.
      </div>;
  }
  const selected = options.find(option => option.value === current) ?? options[0];
  return <div className="not-prose mint-flavor-switcher">
      <style>{`
        .mint-flavor-switcher {
          --mfs-bg: #ffffff;
          --mfs-bg-hover: #f4f4f5;
          --mfs-bg-current: #eef2ff;
          --mfs-border: #d4d4d8;
          --mfs-fg: #18181b;
          --mfs-muted: #71717a;
          --mfs-accent: #4f46e5;
          position: relative;
          width: min(100%, 19rem);
          margin: 0.25rem 0 1.5rem;
          color: var(--mfs-fg);
          font-size: 0.875rem;
          line-height: 1.25rem;
        }

        .dark .mint-flavor-switcher {
          --mfs-bg: #18181b;
          --mfs-bg-hover: #27272a;
          --mfs-bg-current: #272747;
          --mfs-border: #3f3f46;
          --mfs-fg: #fafafa;
          --mfs-muted: #a1a1aa;
          --mfs-accent: #a5b4fc;
        }

        .mint-flavor-switcher details {
          position: relative;
        }

        .mint-flavor-switcher summary {
          display: flex;
          min-height: 2.75rem;
          box-sizing: border-box;
          align-items: center;
          justify-content: space-between;
          gap: 0.75rem;
          padding: 0.625rem 0.75rem;
          border: 1px solid var(--mfs-border);
          border-radius: 0.625rem;
          background: var(--mfs-bg);
          color: var(--mfs-fg);
          cursor: pointer;
          font-weight: 600;
          list-style: none;
          transition: border-color 150ms ease, box-shadow 150ms ease;
        }

        .mint-flavor-switcher summary::-webkit-details-marker {
          display: none;
        }

        .mint-flavor-switcher summary:hover {
          border-color: var(--mfs-accent);
        }

        .mint-flavor-switcher summary:focus-visible {
          outline: 2px solid var(--mfs-accent);
          outline-offset: 2px;
        }

        .mint-flavor-switcher__label {
          overflow: hidden;
          text-overflow: ellipsis;
          white-space: nowrap;
        }

        .mint-flavor-switcher__chevron {
          flex: none;
          transition: transform 150ms ease;
        }

        .mint-flavor-switcher details[open] .mint-flavor-switcher__chevron {
          transform: rotate(180deg);
        }

        .mint-flavor-switcher__menu {
          position: absolute;
          z-index: 50;
          top: calc(100% + 0.375rem);
          left: 0;
          width: 100%;
          box-sizing: border-box;
          margin: 0;
          padding: 0.375rem;
          border: 1px solid var(--mfs-border);
          border-radius: 0.625rem;
          background: var(--mfs-bg);
          box-shadow: 0 12px 30px rgb(0 0 0 / 16%);
          list-style: none;
        }

        .mint-flavor-switcher__menu li {
          margin: 0;
          padding: 0;
        }

        .mint-flavor-switcher__option {
          display: grid;
          gap: 0.125rem;
          padding: 0.625rem 0.75rem;
          border-radius: 0.4rem;
          color: var(--mfs-fg);
          text-decoration: none;
        }

        .mint-flavor-switcher__option:hover {
          background: var(--mfs-bg-hover);
        }

        .mint-flavor-switcher__option:focus-visible {
          outline: 2px solid var(--mfs-accent);
          outline-offset: -2px;
        }

        .mint-flavor-switcher__option[aria-current="page"] {
          background: var(--mfs-bg-current);
          color: var(--mfs-accent);
        }

        .mint-flavor-switcher__name {
          font-weight: 600;
        }

        .mint-flavor-switcher__description {
          color: var(--mfs-muted);
          font-size: 0.8125rem;
        }

        @media (prefers-reduced-motion: reduce) {
          .mint-flavor-switcher summary,
          .mint-flavor-switcher__chevron {
            transition: none;
          }
        }
      `}</style>

      <details>
        <summary aria-label={`${label}: ${selected.label}`}>
          <span className="mint-flavor-switcher__label">{selected.label}</span>
          <svg className="mint-flavor-switcher__chevron" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
            <path d="m6 9 6 6 6-6" />
          </svg>
        </summary>

        <ul className="mint-flavor-switcher__menu" aria-label={label}>
          {options.map(option => {
    const isCurrent = option.value === selected.value;
    const href = option.href ?? `${baseHref.replace(/\/$/, "")}/${encodeURIComponent(option.value)}`;
    return <li key={option.value}>
                <a className="mint-flavor-switcher__option" href={href} aria-current={isCurrent ? "page" : undefined}>
                  <span className="mint-flavor-switcher__name">
                    {option.label}
                  </span>
                  {option.description ? <span className="mint-flavor-switcher__description">
                      {option.description}
                    </span> : null}
                </a>
              </li>;
  })}
        </ul>
      </details>
    </div>;
};

<div className="mint-flavor-switcher-slot not-prose">
  <FlavorSwitcher
    current="js"
    baseHref="/doc/api-reference/widgets"
    options={[
{ value: "js", label: "JavaScript", description: "InstantSearch.js" },
{ value: "react", label: "React", description: "React InstantSearch" },
{ value: "vue", label: "Vue", description: "Vue InstantSearch" },
{ value: "ios", label: "iOS", description: "InstantSearch iOS" },
{ value: "android", label: "Android", description: "InstantSearch Android" },
{ value: "flutter", label: "Flutter", description: "Algolia for Flutter" },
]}
  />
</div>

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.                          |