The DimensionSearchAutoSuggestItem
cartridge returns a set of auto-suggestions that are rendered in the auto-suggestion panel that appears in the search box after the shopper types a specified number of characters. The auto-suggestions themselves are the display names of dimension values, from specified dimensions, that match the characters entered by the shopper.
The XML template for the DimensionSearchAutoSuggestItem
cartridge is located in <ATG11dir>/CommerceReferenceStore/Store/Storefront/deploy/cartridge_templates/DimensionSearchAutoSuggestItem/template.xml
. This XML template has these properties:
title
: A title that can be displayed above the dimension value search results. Note that Commerce Reference Store does not render this property.displayImage
: A Boolean property that, when set totrue
, causes a thumbnail image to display next to each dimension value auto-suggestion. Commerce Reference Store sets this property tofalse
.maxResults
: Specifies the maximum number of auto-suggestions, across all dimensions, to display. The default value for this property is eight.dimensionList
: Specifies the dimensions whose dimension values should be searched for matches to the characters entered by the shopper. The order of the dimensions in this list also dictates the order in which the resulting auto-suggestions are displayed in the panel. Commerce Reference Store sets this list toproduct.brand
andproduct.features.displayName
.
Note that, like the AutoSuggestPanel
cartridge, the DimensionSearchAutoSuggestItem
cartridge does not have its own renderer in Commerce Reference Store. Instead, it is rendered through a custom Dojo widget that is implemented as part of the SearchBox.jsp
renderer. See SearchBox for more details.