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

# Searcher

> Manages search sessions and requests.

export const SearchRequest = () => <Tooltip tip="A search request is a single HTTP call to the Algolia Search API that can run one or more search operations. It can include multiple queries, for example, when querying several indices at once.">
    search request
  </Tooltip>;

export const SearchQuery = () => <Tooltip tip="The text users enter into a search box. In the Search API, this corresponds to the query parameter. A search query is often used with filters, facets, and other parameters, but these aren't part of the query text itself.">
    search query
  </Tooltip>;

export const Index = () => <Tooltip tip="An Algolia index is a searchable dataset that consists of records and configuration settings. These settings define how the records are searched and ranked.">
    index
  </Tooltip>;

export const Facet = () => <Tooltip tip="An attribute in your records that lets users filter or group results (for example, by color, brand, or price)." cta="Faceting" href="/doc/guides/managing-results/refine-results/faceting">
    facet
  </Tooltip>;

export const Events = () => <Tooltip tip="An event is a specific action a user takes in your app or on your website." cta="Events" href="/doc/guides/sending-events">
    events
  </Tooltip>;

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="ios"
    baseHref="/doc/api-reference/widgets/instantsearch"
    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>

{/* vale Algolia.HeadingPronouns = NO */}

## About this widget

Objects conforming to the [Searcher protocol](https://github.com/algolia/instantsearch-core-swift/blob/master/Sources/Searcher/Searcher.swift)
manage the search sessions.

Algolia provides you with several out of the box searchers to help build your InstantSearch experience:

* `HitsSearcher`. Searches a single <Index />.
* `FacetSearcher`. Searches for <Facet /> values.
* `MultiSearcher`. Aggregates the hits and facet searchers. This is useful for building a federated search, or query suggestions.

<Card title="Explore example code" icon="github" href="https://github.com/algolia/instantsearch-ios/tree/master/Examples/Showcase">
  Browse the Searcher example code on GitHub.
</Card>

## Examples

Instantiate a `HitsSearcher`.

```swift Swift icon=code theme={"system"}
let searcher = HitsSearcher(appID: "YourApplicationID",
                            apiKey: "YourSearchOnlyApiKey",
                            indexName: "index_name",
                            isAutoSendingHitsViewEvents: true)
```

Instantiate a `FacetSearcher`.

```swift Swift icon=code theme={"system"}
let searcher = FacetSearcher(appID: "YourApplicationID",
                             apiKey: "YourSearchOnlyApiKey",
                             indexName: "index_name",
                             facetName: "facet_name")
```

Instantiate a `MultiSearcher`.

```swift Swift icon=code theme={"system"}
let searcher = MultiSearcher(appID: "YourApplicationID",
                             apiKey: "YourSearchOnlyApiKey")
searcher.addHitsSearcher(indexName: "index_name1")
searcher.addFacetsSearcher(indexName: "index_name1",
                            attribute: "facet_name")
searcher.addHitsSearcher(indexName: "index_name2")
```

## HitsSearcher

<ParamField body="indexName" type="String" required>
  The index to search.

  ```swift Swift icon=code theme={"system"}
  let searcher = HitsSearcher(appID: "YourApplicationID",
                              apiKey: "YourSearchOnlyApiKey",
                              indexName: "index_name")
  ```
</ParamField>

<ParamField body="query" type="Query" default="Query()">
  A <SearchQuery />.

  ```swift Swift icon=code theme={"system"}
  let query = Query()
  query.analytics = true
  let searcher = HitsSearcher(appID: "YourApplicationID",
                              apiKey: "YourSearchOnlyApiKey",
                              indexName: "index_name",
                              query: query)
  ```
</ParamField>

<ParamField body="isAutoSendingHitsViewEvents" type="Bool" default={false} post={["since: v7.26.2"]}>
  Whether to automatically send view <Events /> for hits.

  ```swift Swift icon=code theme={"system"}
  let searcher = HitsSearcher(appID: "YourApplicationID",
                              apiKey: "YourSearchOnlyApiKey",
                              indexName: "index_name",
                              isAutoSendingHitsViewEvents: true)
  ```
</ParamField>

## FacetSearcher

<ParamField body="indexName" type="String" required>
  The index to search into.

  ```swift Swift icon=code theme={"system"}
  let searcher = FacetSearcher(appID: "YourApplicationID",
                               apiKey: "YourSearchOnlyApiKey",
                               indexName: "index_name")
  ```
</ParamField>

<ParamField body="facetName" type="String" required>
  The facet name to search into when doing search for facet values.

  ```swift Swift icon=code theme={"system"}
  let searcher = FacetSearcher(appID: "YourApplicationID",
                               apiKey: "YourSearchOnlyApiKey",
                               indexName: "index_name",
                               facetName: "facet_name")
  ```
</ParamField>

<ParamField body="query" type="Query" default="Query()">
  The query used when doing a search.

  ```swift Swift icon=code theme={"system"}
  let query = Query()
  query.analytics = true
  let searcher = FacetSearcher(appID: "YourApplicationID",
                               apiKey: "YourSearchOnlyApiKey",
                               indexName: "index_name",
                               query: query)
  ```
</ParamField>

## Methods

<ParamField body="search">
  Triggers the search. Notifies all listeners of the results.

  ```swift Swift icon=code theme={"system"}
  searcher.search()
  ```
</ParamField>

<ParamField body="cancel">
  Cancels every ongoing <SearchRequest />.

  ```swift Swift icon=code theme={"system"}
  searcher.cancel()
  ```
</ParamField>

## Events

<ParamField body="isLoading">
  Triggered when the `Searcher` starts or finishes query execution.

  ```swift Swift icon=code theme={"system"}
  searcher.isLoading.subscribe(with: self) { (_, isLoading) in

  }
  ```
</ParamField>

<ParamField body="onQueryChanged">
  Triggered when the query text is modified.

  ```swift Swift icon=code theme={"system"}
  searcher.onQueryChanged.subscribe(with: self) { (_, query) in

  }
  ```
</ParamField>

<ParamField body="onResults">
  Triggered when a new search result is received.

  ```swift Swift icon=code theme={"system"}
  searcher.onResults.subscribe(with: self) { (_, results) in

  }
  ```
</ParamField>

<ParamField body="onError">
  Triggered when a new error is received.

  ```swift Swift icon=code theme={"system"}
  searcher.onError.subscribe(with: self) { (_, args) in
    let (query, error) = args

  }
  ```
</ParamField>