Skip to main content
Version: current

API Reference

info

The following content is for DocSearch v3. If you are using DocSearch v2, see the legacy documentation.

container#

type: string | HTMLElement | required

The container for the DocSearch search box. You can either pass a CSS selector or an Element. If there are several containers matching the selector, DocSearch picks up the first one.

environment#

type: typeof window | default: window | optional

The environment in which your application is running.

This is useful if you’re using DocSearch in a different context than window.

appId#

type: string | required

Your Algolia application ID.

apiKey#

type: string | required

Your Algolia Search API key.

indexName#

type: string | required

Your Algolia index name.

placeholder#

type: string | `default: "Search docs" | optional

The placeholder of the input of the DocSearch pop-up modal.

searchParameters#

type: SearchParameters | optional

The Algolia Search Parameters.

transformItems#

type: function | default: items => items | optional

Receives the items from the search response, and is called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, and remove or reorder them.

docsearch({  // ...  transformItems(items) {    return items.map((item) => ({      ...item,      content: item.content.toUpperCase(),    }));  },});

hitComponent#

type: ({ hit, children }) => JSX.Element | default: Hit | optional

The component to display each item.

See the default implementation.

transformSearchClient#

type: function | default: searchClient => searchClient | optional

Useful for transforming the Algolia Search Client, for example to debounce search queries

disableUserPersonalization#

type: boolean | default: false | optional

Disable saving recent searches and favorites to the local storage.

initialQuery#

type: string | optional

The search input initial query.

navigator#

type: Navigator | optional

An implementation of Algolia Autocomplete’s Navigator API to redirect the user when opening a link.

Learn more on the Navigator API documentation.