📢 Use this project, contribute to it or open issues to help evolve it using Store Discussion.

Product Brand

The ProductBrand is a VTEX block that displays either the name or the logo of a product's brand.

product-brand

Configuration

  1. Import the vtex.product-summary app to your theme's dependencies in the manifest.json, for example:
  "dependencies: {
    "vtex.product-summary": "2.x"
  }
  1. Add the product-brand block to any block below store.product(Product template). For example:
  "store.product": {
    "children": [
      "flex-layout.row#product",
    ]
  },
  "flex-layout.row#product": {
    "children": [
      "product-brand"
    ]
  },
  "product-brand": {
    "props": {
      "displayMode": "text"
    }
  },

Configuration

Prop nameTypeDescription
displayModeStringYou should choose between logo or text. This will define if the product brand will be displayed by name or logo.
fallbackToTextBooleanThis prop should only be used when displayMode is set to logo. It defines what should be done when the Product Brand was set to display a brand logo but no image was registered in the VTEX admin's Catalog. This prop is set as true by default, allowing the logo to be replaced with the brand name in those scenarios. When set as false, the store will not show the brand name instead of the brand logo.
heightNumberIt sets the logo height. It should only be used when displayMode is set to logo.
excludeBrandsArrayThe brand names or brand IDs listed in the array will never be displayed by the Brand component. It is usually useful to hide default or test brand names/logos on the store front.
logoWithLinkbooleanIf the brand logo will have a link that leads to the store's brand page (true) ou not (false)
brandNameStringThe brand name. If this value is not passed, it will be obtained through the product context.
brandIdNumberThe brand id. If this value is not passed, it will be obtained through the product context.

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.