SearchOptions

PropTypeDescription
enabledboolean = falseEnable search
getHref( reference: SearchResult | AlgoliaDocSearchHit, ) => string | undefinedCallback to transform a search result into an href
getHeading( reference: SearchResult | AlgoliaDocSearchHit, query: string, ) => string | undefinedCallback to transform a search result into a heading
getTitle( reference: SearchResult | AlgoliaDocSearchHit, query: string, ) => string | undefinedCallback to transform a search result into a title
getSubtitle( reference: SearchResult | AlgoliaDocSearchHit, query: string, ) => string | undefinedCallback to transform a search result into a subtitle
labelstring = "Search documentation"Label for the search input, not shown but used for `aria-label`
askLabelstring = "Ask AI"Label for the "Ask AI" link when using "input" layout
defaultViewDefaultSearchViewPropsDefault (empty) view
tabLabelstring = "Search"Label for the tab bar
placeholderstring = "Search documentation"Placeholder for the search input

SubmitSearchQueryOptions

PropTypeDescription
limitnumber = 8Maximum amount of results to return
providerAlgoliaProviderCustom provider configuration
signalAbortSignalAbortController signal