Interface CategoryFilterSuggestionsAlpha

clear

• clear(): void
  Alpha

  Resets the query in the controller state and clears the category filter suggestions.

  Returns void

getSearchParameters

• getSearchParameters(value: CategoryFieldSuggestionsValue): string
  Alpha

  Returns the serialized search parameters for the current search query and specified category filter suggestion.

  For example, q=jeans&cf-ec-category=Clothes,Pants.

  In a typical scenario, this method should called when the user selects a category filter suggestion from a standalone search box. The returned string is then used to pass the correct URL query parameters or fragment when redirecting the browser to the search page.

  When the user selects a category filter suggestion from the main search box on the search page, use the select method instead.

  Parameters

  • value: CategoryFieldSuggestionsValue

    The category filter suggestion to serialize.

  Returns string

  The serialized search parameters for the current search query and specified category filter suggestion.

select

• select(value: CategoryFieldSuggestionsValue): void
  Alpha

  Clears all facet values, selects the specified category filter suggestion, updates the query, and executes a new search request.

  In a typical scenario, this method should be called when the user selects a category filter suggestion from the main search box on the search page.

  When the user selects a category filter suggestion from a standalone search box, use the getSearchParameters method instead.

  Parameters

  • value: CategoryFieldSuggestionsValue

    The category filter suggestion to select.

  Returns void

updateQuery

• updateQuery(query: string): void
  Alpha

  Sets the query in the controller state to the specified value and requests category filter suggestions based on the updated query.

  For example, if this method is called with jeans as an argument, it will request values from the controller's field (e.g., ec_category) that would return results if selected when the search query is jeans (such as Clothing, Clothing;Pants, and Clothing;Shorts).

  Parameters

  • query: string

    The search query to use as context to request the category filter suggestions. In a typical scenario, this should set to the current value of the search box input.

  Returns void

Alphastate