API Reference / InstantSearch iOS

Before building your UI, don't forget to install the library.

Basics

Searcher

The component handling search requests.

SearchBox

Component that performs a text-based query.

Query

A component to provide any search parameters to Algolia.

RelatedItems

Experimental component that computes search parameters to fetch related items.

Filter State

FilterState provides a friendly interface to manage filters applied to your search.

Loading

Components that show a loading indicator during pending requests.

Results

Hits

Component that manages and displays a list of search results.

Highlighting

Set of tools to highlight relevant parts of the search results.

Multi Hits

InstantSearch iOS doesn’t offer a Multi Hits widget.

Refinements

Refinement List

Components that perform refinements on a facet.

Filter List (Facet)

Component that displays a list of arbitrary facet filters.

Filter List (Numeric)

Components that display a list of arbitrary numeric filters.

Filter List (Tag)

Components that display a list of arbitrary tag filters.

Dynamic Facet List

Component presenting the ordered facets, facet values and handling the user interaction to refine search results. The order of facets and their values is defined by the facet merchandising settings of the index.

Hierarchical Menu

Components that build a hierarchical menu.

Filter Numeric Range

Components that apply a numeric range filter.

Filter Map

Components that apply a single filter from a map.

Current Filters

Components that display the current filters and let users remove them.

Filter Toggle

Components that toggle an arbitrary filter on or off.

Clear Filters

Components that clear the current filters.

Metadata

Stats

Components that display metadata about the current search and its results.

QueryRuleCustomData

Component that displays custom data from Rules.

Sorting

Sort By

Components that display a list of indices, allowing a user to change the way hits are sorted (using replica indices).

RelevantSort

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.

Did you find this page helpful?