SearchOptions

Prop Type Description Default
enabled boolean

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

label string

Label for the search input, not shown but used for aria-label

"Search documentation"
askLabel string

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

"Ask AI"
defaultView DefaultSearchViewProps

Default (empty) view

tabLabel string

Label for the tab bar

"Search"
placeholder string

Placeholder for the search input

"Search documentation"

SubmitSearchQueryOptions

Prop Type Description Default
limit number

Maximum amount of results to return

8
provider AlgoliaProvider

Custom provider configuration

signal AbortSignal

AbortController signal