SearchBox (Commerce Engine)

This is for:

Developer
In this article
Important

The Headless commerce engine, controllers, and actions are in open beta and therefore under active development. Reach out to your Coveo team for support in adopting them.

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.