Home > widget-integration > SearchSettings

SearchSettings interface

Search settings from admin configuration.

**Legacy**: Retrieved via getSearchSettings(context) utility **New**: Same data but with full TypeScript interface

Signature:

interface SearchSettings$1 

Properties

Property

Modifiers

Type

Description

enableDefaultResult?

boolean

(Optional) Whether default result is enabled

enableFuzzySearch?

boolean

(Optional) Whether fuzzy search is enabled

enablePlusCharacterSearch?

boolean

(Optional) Enable plus character in search queries

fullMinMatch?

boolean

(Optional) Full minimum match

productAvailable?

boolean

(Optional) Product availability filter

reduceMinMatch?

boolean

(Optional) Reduce minimum match threshold

searchBoxOnclick

SearchBoxOnClickSettings

Search box on-click settings

showVariantsAsProduct?

boolean

(Optional) Show variants as separate products

skipFields?

string[]

(Optional) Fields to skip in search results

suggestionBlocks

SuggestionBlock$1[]

Suggestion blocks configuration

suggestionDymLimit?

number

(Optional) Did-you-mean suggestion limit

suggestionMaxHeight

number

Maximum height for suggestion panel

suggestionMobileProductItemType?

"grid" | "list"

(Optional) Mobile product item type

suggestionMobileStyle?

"style1" | "style2"

(Optional) Mobile suggestion style.

No longer returned by the admin API. Can be provided by the Liquid template (e.g. {% assign suggestionMobileStyle = 'style2' %} serialised into the block settings JSON) to force dropdown style on mobile/tablet.

Omitted (or 'style1') → full-width overlay on mobile/tablet. 'style2' → dropdown style on mobile/tablet.

suggestionMode?

"prod" | "test"

(Optional) Suggestion mode (prod/test) — controls scoped/narrowing suggestions

suggestionNoResult

SuggestionNoResultSettings

No result fallback settings

suggestionStyle

"style1" | "style2" | "style3"

Desktop suggestion style

suggestionStyle2ProductItemType

"grid" | "list"

Product item type for style2