SearchSettings

The SearchSettings object represents settings for search function in the storefront.

classDiagram
  direction LR
  class SearchSettings{
    bool isSearchSuggestLayerEnabled
    bool isSearchInCategoriesEnabled
    bool isSearchInProducersEnabled
    bool isSearchInProductsEnabled
    bool isPhraseSuggestionsEnabled
    bool isNamesShorteningEnabled
    bool isSearchButtonPinnedOnMobile
    bool isSearchResultsDisplayFormatChangeAllowed
    bool isLoadingMoreSearchResultsEnabled
    int numberOfSearchResultsPerPage
    bool showProductRate
    bool showProductAvailability
    bool showProductPrice
  }

Properties

Attribute name	Type	Description
isSearchSuggestLayerEnabled	bool	Indicates whether search suggest layer is enabled.
isSearchInCategoriesEnabled	bool	Indicates whether search in categories is enabled.
isSearchInProducersEnabled	bool	Indicates whether search in producers is enabled.
isSearchInProductsEnabled	bool	Indicates whether search in products is enabled.
isPhraseSuggestionsEnabled	bool	Indicates whether phrase suggestions are enabled.
isNamesShorteningEnabled	bool	Indicates whether long names shortening is enabled.
isSearchButtonPinnedOnMobile	bool	Indicates whether search button is pinned to it's position on mobile devices.
isSearchResultsDisplayFormatChangeAllowed	bool	Indicates whether search results display format change is allowed by end user.
isLoadingMoreSearchResultsEnabled	bool	Indicates whether link in the end of search results should load more results or redirect end user to the search results page.
numberOfSearchResultsPerPage	int	Number of search results per page.
showProductRate	bool	Indicates whether search results display products' rate.
showProductAvailability	bool	Indicates whether search results display products' availability.
showProductPrice	bool	Indicates whether search results display products' price.

Examples

isSearchSuggestLayerEnabled property

sourceoutput

{{ searchSettings.isSearchSuggestLayerEnabled }}

true

isSearchInCategoriesEnabled property

sourceoutput

{{ searchSettings.isSearchInCategoriesEnabled }}

true

isSearchInProducersEnabled property

sourceoutput

{{ searchSettings.isSearchInProducersEnabled }}

true

isSearchInProductsEnabled property

sourceoutput

{{ searchSettings.isSearchInProductsEnabled }}

true

isPhraseSuggestionsEnabled property

sourceoutput

{{ searchSettings.isPhraseSuggestionsEnabled }}

true

isNamesShorteningEnabled property

sourceoutput

{{ searchSettings.isNamesShorteningEnabled }}

true

isSearchButtonPinnedOnMobile property

sourceoutput

{{ searchSettings.isSearchButtonPinnedOnMobile }}

true

isSearchResultsDisplayFormatChangeAllowed property

sourceoutput

{{ searchSettings.isSearchResultsDisplayFormatChangeAllowed }}

true

isLoadingMoreSearchResultsEnabled property

sourceoutput

{{ searchSettings.isLoadingMoreSearchResultsEnabled }}

true

numberOfSearchResultsPerPage property

sourceoutput

{{ searchSettings.numberOfSearchResultsPerPage }}

30

showProductRate property

sourceoutput

{{ searchSettings.showProductRate }}

true

showProductAvailability property

sourceoutput

{{ searchSettings.showProductAvailability }}

true

showProductPrice property

sourceoutput

{{ searchSettings.showProductPrice }}

true