VTEX Developer Portal

Basic components

Storefront components indispensable to create an end-to-end experience for your store’s users.

Add to cart Button

A button for adding items into the shopping cart.
See more

Breadcrumb

Navigation scheme that shows a user's browsing history up to their current location in your store.
See more

Footer

Displays your store's Footer.
See more

Google One-Tap Login

Google One-tap delivers a seamless experience with a small pop-up that can authenticate a user with a streamlined interface.
See more

Header

Displays your store's Header.
See more

Locale Switcher

Component responsible for changing the current language of the store.
See more

Login

Handles every functionality related to user login.
See more

Menu

Renders the Menu component, displaying a bar containing links and drop-down sub-menus.
See more

Minicart

Fetching data from the Checkout OrderForm API, the Minicart component displays a summary list of all items added by customers in their shopping cart.
See more

Order Placed

Renders the the orderPlaced page with all order data.
See more

Product Customizer

Allows a product's attachments to be made available and ready to be chosen by users from the product page.
See more

Product Identifier

Shows a product identifier, such as the product reference, product ID, sku EAN or sku reference.
See more

Product List

Works with Minicar to display all items in the user's cart, informing when some of them are unavailable.
See more

Product Price

The app exports blocks related to the product's price, such as list price, selling price and savings.
See more

Product Quantity

Allows users to a add a chosen amount of the displayed product in their cart.
See more

Product Specification Badges

This block is exported by the Product Summary app and it is responsible for displaying badges with the product's specifications in other store blocks.
See more

Product Summary

App responsible for summarizing product information (such as name, price and image) in other store blocks, such as the Shelf and the Minicart.
See more

Product Summary Attachment List

This block is exported by the Product Summary app and it is responsible for displaying the product's attachments in other store blocks.
See more

Product Summary Brand

This block is exported by the Product Summary app and it is responsible for displaying the product's brand in other store blocks.
See more

Product Summary Buy Button

This block is exported by the Product Summary app and it is responsible for displaying a Buy Button block in other store blocks.
See more

Product Summary Description

This block is exported by the Product Summary app and it is responsible for displaying the product's description in other store blocks.
See more

Product Summary Image

This block is exported by the Product Summary app and it is responsible for displaying the product's image in other store blocks.
See more

Product Summary List

This block is exported by the Product Summary app and it is responsible for displaying a products list in other store blocks.
See more

Product Summary Name

This block is exported by the Product Summary app and it is responsible for displaying the product's name in other store blocks.
See more

Product Summary SKU Selector

This block is exported by the Product Summary app and it is responsible for displaying the SKU Selector block in other store blocks.
See more

Rich Text

The Rich Text brings texts to your store and everything else that Markdown language is able to. It converts texts written in Markdown language and displays its content as HTML elements.
See more

Search

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.
See more

Search Result

Handles the result fetched by the VTEX Search API and displaying it to users. The app exports all store blocks expected in a search results page, such as the filters and the product gallery.
See more

Shelf

Displays a list of products in the store home page.
See more

Store Image

Render an pre-defined image on the UI.
See more

Updated 3 months ago


Basic components


Suggested Edits are limited on API Reference Pages

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