SearchOptions

PropTypeDescriptionDefault
enabledboolean

Enable search

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

"Search documentation"
askLabelstring

Label for the "Ask AI" link when using "input" layout

"Ask AI"
defaultViewDefaultSearchViewProps

Default (empty) view

tabLabelstring

Label for the tab bar

"Search"
placeholderstring

Placeholder for the search input

"Search documentation"

SubmitSearchQueryOptions

PropTypeDescriptionDefault
limitnumber

Maximum amount of results to return

8
providerAlgoliaProvider

Custom provider configuration

signalAbortSignal

AbortController signal