📢 Use, contribute or open issues for this project through Store Discussion.

Breadcrumb

The VTEX BreadCrumb is a navigation scheme that shows a user's browsing history up to their current location in your store.

img2-breadcrumb

Configuration

  1. Import the breadcrumb's app to your theme's dependencies in the manifest.json, for example:
  dependencies: {
    "vtex.breadcrumb": "1.x"
  }
  1. Add the breadcrumb block to the Product and Search template. For example:
 "breadcrumb": {
    "props": {
      "showOnMobile": true
    }
  },
Prop nameTypeDescriptionDefault value
showOnMobileBooleanIt determines whether Breadcrumb should also be displayed on mobilefalse
homeIconSizeNumberControls the size property of IconHome26
caretIconSizeNumberControls the size property of IconCaret8

⚠️ The product's categories should appear as an array in one of this two formats:

categories = ['/Eletronics/', '/Eletronics/Computers']
categories = ['eletronics', 'eletronics-computers']

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
container
link
arrow
homeLink
termArrow