Search page

Search page



We've just implemented our product page and are moving on to the search page. Both are similar in the sense that both have blocks that are unique in this context. We will explore this block in a disorderly fashion, for now, just to get an idea of its behavior.

Starting out with Search Layout

Same as other templates, can also be flexible. To build a unique layout you'll need to use a block called search-result-layout.

  "": {
    "blocks": ["search-result-layout"]

The search-result-layout, in turn, must receive 3 other blocks:

  • search-result-layout.desktop
  • search-not-found-layout

As you've already noticed, the first two define which layout will be displayed on desktop and mobile respectively, while the third defines the layout of the no results found search page.

  "": {
    "blocks": ["search-result-layout"]
  "search-result-layout": {
    "blocks": [

In the course, we'll focus on desktop layout implementation.

Search blocks

The search results documentation offers a good reference for blocks that can be used in a search context. This step will focus on highlighting the main ones:

  • Search breadcrumb (;
  • Search title (search-title.v2);
  • Total products found (total-products.v2);
  • Product ordering (order-by.v2);
  • Show more results button (search-fetch-more);
  • Show previous results button (search-fetch-previous);
  • Navigation filter (filter-navigator.v3);
  • Search results (search-content)

Although quite many, all these blocks are relatively simple and work very well without an express need to configure their props.



Copy the code above in search.jsonc and define a search-result-layout.desktop having the following, in the order mentioned below:

  • search-title.v2;
  • total-products.v2;
  • order-by.v2;
  • search-fetch-previous;
  • search-content;
  • filter-navigator.v3;
  • search-fetch-more.

To do so, write a code similar to:

  "search-result-layout.desktop": {
    "children": [

Note: Remember to go through the Search Result documentation if you have any questions during the activity.

Any questions?

See the answersheet for this step or check our [office hours] on the VTEX Developers channel(

Congratulations, you finished the course!
Still have time left?
Try our challenge for this course!

Help us make this content better!

VTEX IO courses are open source. If you see something wrong, you can open a pull request!

Make a contribution

or open an issue