SearchBox (Commerce Engine)

This is for:

Developer
In this article
Note

This component was introduced in version 2.63.5.

The SearchBox headless controller offers a high-level interface for designing a common search box UI component with highlighting for query suggestions.

Initialize

buildSearchBox

Creates a SearchBox controller instance.

Parameters

  • engine: CommerceEngine

    The commerce headless engine.

  • props: SearchBoxProps

    The configurable SearchBox properties.

Returns SearchBox

SearchBoxProps

The configurable SearchBox properties.

Properties

  • options?: Pick<CoreSearchBoxOptions, 'id' | 'highlightOptions' | 'clearFilters'>

    The SearchBox controller options.