VTEX Developer Portal

All ContributorsAll Contributors

The VTEX Search app is responsible for handling the new VTEX Intelligent Search solution in IO stores by providing new UI components that enhance the search experience, such as the autocomplete feature.

search-app-gifsearch-app-gif

Configuration

:warning: The proper functioning of the Search app components relies on having already installed apps [email protected] and [email protected] in your store. For more on this, access our Help Center track on VTEX Intelligent Search.

Step 1 - Adding the Search app to your theme's dependencies

Add the search app to your theme's dependencies in the manifest.json as showed below:

  "dependencies": {
+   "vtex.search": "2.x"
  }

You are now able to use all of the blocks exported by the search app. Check the full list below:

Block nameDescription
autocomplete-result-list.v2Provides customized autocomplete features in the search bar component, such as top searches, search history, product suggestions or term suggestions. You can read more about the Intelligent Search autocomplete feature on VTEX Help Center.
search-bannerRenders a customized banner according to the search query performed.
did-you-meanHelps users with possible misspelling corrections for the current search query.
search-suggestionsRenders a list of similar search terms for the current search query.

:warning: The blocks search-banner, did-you-mean and search-suggestions require you to have Search Results app version 3.x or higher installed in your theme.

Step 2 - Adding the Search's blocks into the theme

First, declare the autocomplete-result-list.v2 block as a child block of the search-bar block, exported by the Store Components app. For example:

{
  "search-bar": {
    "blocks": ["autocomplete-result-list.v2"],
    "props": {
      "openAutocompleteOnFocus": true
    }
  }
}

autocomplete-result-list.v2 props

Prop nameTypeDescriptionDefault value
maxTopSearchesnumberMaximum number of items in the top searches list.10
maxHistorynumberMaximum number of items in the search history list.5
maxSuggestedProductsnumberMaximum number of items in the suggested products list.3
maxSuggestedTermsnumberMaximum number of items in the suggested terms list.3
autocompleteWidthnumberAutocomplete list width (in percent). The value must be between 0 and 100undefined
productLayoutenumDefines the suggested products list layout when rendered. Possible values are HORIZONTAL and VERTICAL.undefined
hideTitlesbooleanDefines whether all component titles are hidden when rendered (true) or not (false).false
hideUnavailableItemsbooleanDefines whether the autocomplete should hide unavailable items (true) or not (false).false
historyFirstbooleanDefines whether the search history list should be prioritized over the other lists (true) or not (false).false
customBreakpointsobjectDefines a maximum number of suggested products by breakpoints. Possible values are md, lg or xlg.-
simulationBehavior"skip" or "default"If you want faster searches and do not care about most up to date prices and promotions, use "skip" value.default
HorizontalProductSummaryproduct-summary blockBy default, the mobile autocomplete uses the CustomListItem component to render the suggested products with a horizontal layout. But if you send a product-summary block here, it will render your customized Product Summary component. You can see how to build a horizontal Product Summary component hereundefined
  • customBreakpoints object:
Prop nameTypeDescriptionDefault value
mdobjectDefines the maximum number of suggested products for the md breakpoint.undefined
lgobjectDefines the the maximum number of suggested products for the lg breakpoint.undefined
xlgobjectDefines the the maximum number of suggested products for the xlg breakpoint.undefined
  • md, lg and xlg objects:
Prop nameTypeDescriptionDefault value
widthnumberBreakpoint minimum width.undefined
maxSuggestedProductsnumberMaximum number of suggested products.undefined

The autocomplete-result-list.v2 block also allows you to add a list of child blocks onto it.

This means that you can declare a theme block of your choosing and have it rendered among the autocomplete features. For example:

{
  "autocomplete-result-list.v2": {
    "blocks": ["product-summary"]
  }
}

Now, the time has come to add the last 3 search blocks: search-banner, did-you-mean and search-suggestions.

Those blocks, differently from autocomplete-result-list.v2, need to be added under the search-result-layout.desktop or the search-result-layout.mobile blocks, according to the Search Results block hierarchy.

Once added, these can be declared using their respective props for their configuration. For example:

{
  "search-result-layout.desktop": {
    "children": [
      "flex-layout.row#did-you-mean",
      "flex-layout.row#suggestion",
      "flex-layout.row#banner-one",
      "flex-layout.row#result"
    ],
    "props": {
      "pagination": "show-more",
      "preventRouteChange": true,
      "mobileLayout": {
        "mode1": "small",
        "mode2": "normal"
      }
    }
  },

  "flex-layout.row#did-you-mean": {
    "children": ["did-you-mean"]
  },
  "flex-layout.row#suggestion": {
    "children": ["search-suggestions"]
  },
  "flex-layout.row#banner-one": {
    "children": ["search-banner#one"]
  },

  "search-banner#one": {
    "props": {
      "area": "one",
      "blockClass": "myBanner",
      "horizontalAlignment": "center"
    }
  }
}

search-banner props

Prop nameTypeDescriptionDefault value
areastringArea of ​​the store where the banner will be displayed. It needs to match the predefined area value in the banner setup.undefined
blockClassstringUnique block ID to be used in CSS customizationundefined
horizontalAlignmentstringDefines the banner horizontal alignment. Possible values are left, center or right.center

Modus Operandi

The Search app is merely responsible for offering blocks that when rendered as components will improve the user's search experience in stores where the VTEX Intelligent Search engine is already supported.

These components use _q as the query-string for the search term, meaning that if you wish to track the searches of your users in these components you'll need to add the _q query-string to the store's Google Analytics.

Find out how to do this by accessing our Google Analytics search tracking documentation.

Customization

In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on Using CSS Handles for store customization.

CSS Handles
searchBanner
didYouMeanPrefix
didYouMeanTerm
suggestionsList
suggestionsListItem
suggestionsListLink
itemListSubItemLink
itemListLink
itemListLinkTitle

Contributors ✨

Thanks goes out to these wonderful people:

This project follows the all-contributors specification. Contributions of any kind are welcome!

Updated 3 months ago


Search


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.