Developers
Start building
Themes/Theme SDK/Modules/search

search

Storefront search: the query, live results, suggestions and featured products.

On this page
import { … } from '@poltura/theme-sdk/search';

Hooks

NameWhat it is
useSearchThe shopper's search: what they typed, debounced product results, suggestions and featured products.

Parts

NameWhat it is
SearchInputThe search field with its icon and clear button; inside SearchCombobox it is the combobox the arrow keys drive.
SearchResultsThe products matching the query, with the searching and no-results notes.
SearchSuggestionsWhat search offers before the shopper types: popular searches as chips and the featured products.
SearchDialogA search icon button that opens its content in a dialog near the top of the page.
SearchComboboxThe search field as a combobox: suggestions before typing, live results after, the arrow keys walking both and Enter opening the highlighted one.

Defaults

NameWhat it is
HeaderSearchThe complete header search: the field as a combobox, suggestions before typing and live results after.

Types

NameWhat it is
SearchStateThe storefront search: the query, live results, suggestions and the actions that drive them.
SearchSuggestionA suggestion shown before or while the shopper types: a popular or recent search, or a matching category, collection or page.
SearchOptionsOptions of useSearch.
SearchInputPropsProps of SearchInput.
SearchResultsPropsProps of SearchResults.
SearchSuggestionsPropsProps of SearchSuggestions.
SearchDialogPropsProps of SearchDialog.
SearchGroupKindA result group of the search dropdown, as the element type the merchant adds under a search block.
SearchGroupOne result group of the search dropdown, in the order the dropdown lists it.
SearchDropdownHow the search dropdown is drawn.
SearchComboboxPropsProps of SearchCombobox.
HeaderSearchPropsProps of HeaderSearch.
Last updated