SearchOptions

PropTypeDescription
enabledboolean

Enable search Default: false.

getHref( reference: SearchResult | AlgoliaDocSearchHit, ) => string | undefined

Callback to transform a search result into an href

getHeading( reference: SearchResult | AlgoliaDocSearchHit, query: string, ) => string | undefined

Callback to transform a search result into a heading

getTitle( reference: SearchResult | AlgoliaDocSearchHit, query: string, ) => string | undefined

Callback to transform a search result into a title

getSubtitle( reference: SearchResult | AlgoliaDocSearchHit, query: string, ) => string | undefined

Callback to transform a search result into a subtitle

labelstring

Label for the search input, not shown but used for aria-label Default: "Search documentation".

askLabelstring

Label for the "Ask AI" link when using "input" layout Default: "Ask AI".

defaultViewDefaultSearchViewProps

Default (empty) view

tabLabelstring

Label for the tab bar Default: "Search".

placeholderstring

Placeholder for the search input Default: "Search documentation".

SubmitSearchQueryOptions

PropTypeDescription
limitnumber

Maximum amount of results to return Default: 8.

providerAlgoliaProvider

Custom provider configuration

signalAbortSignal

AbortController signal