Product List

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

Product List

The Product List component displays all items in the user's cart and informs users when items are unavailable.

⚠️ Currently, the Product List only works with Minicart v2.

Configuration

Add the Product List app to your theme dependencies in manifest.json. For example:

  "dependencies": {
    "vtex.product-list": "0.x"
  }

Add the product-list block to the minicart-product-list block (exported by the Minicart app). For example:

  "minicart-product-list#example": {
    "blocks": ["product-list"]
  }

Once you have added the product-list to the minicart-product-list, no further actions are required, as the block works with a default implementation behind the scenes. This means that the Product List component is ready to be rendered.

Advanced configuration

Currently, the product-list default implementation is the following:

{
  "product-list": {
    "blocks": [
        "product-list-content-desktop", 
        "product-list-content-mobile"
    ]
  },
  "product-list-content-desktop": {
    "children": ["flex-layout.row#list-row.desktop"]
  },
  "flex-layout.row#list-row.desktop": {
    "children": [
      "flex-layout.col#image.desktop",
      "flex-layout.col#main-container.desktop"
    ],
    "props": {
      "fullWidth": true,
      "paddingBottom": "7",
      "paddingTop": "6",
      "colSizing": "auto",
      "preserveLayoutOnMobile": "true"
    }
  },
  "flex-layout.col#image.desktop": {
    "children": ["product-list-image"],
    "props": {
      "marginRight": "6"
    }
  },
  "flex-layout.col#main-container.desktop": {
    "children": [
      "flex-layout.row#sub-container.desktop",
      "flex-layout.row#message.desktop"
    ],
    "props": {
      "width": "grow"
    }
  },
  "flex-layout.row#sub-container.desktop": {
    "children": [
      "flex-layout.col#product-description",
      "flex-layout.col#quantity.desktop",
      "flex-layout.row#price-remove"
    ],
    "props": {
      "preserveLayoutOnMobile": "true",
      "colSizing": "auto"
    }
  },
  "flex-layout.col#quantity.desktop": {
    "children": [
      "flex-layout.row#quantity-selector.desktop",
      "flex-layout.row#unit-price.desktop"
    ],
    "props": {
      "marginLeft": "8"
    }
  },
  "flex-layout.row#price-remove": {
    "children": [
      "flex-layout.col#price.desktop",
      "flex-layout.col#remove-button.desktop"
    ],
    "props": {
      "colSizing": "auto"
    }
  },
  "flex-layout.row#quantity-selector.desktop": {
    "children": ["quantity-selector"],
    "props": {
      "preventHorizontalStretch": "true"
    }
  },
  "flex-layout.row#unit-price.desktop": {
    "children": ["unit-price#desktop"],
    "props": {
      "marginTop": "3",
      "preventHorizontalStretch": "true"
    }
  },
  "unit-price#desktop": {
    "props": {
      "textAlign": "center"
    }
  },
  "flex-layout.col#price.desktop": {
    "children": ["price#desktop"],
    "props": {
      "blockClass": "priceWrapper",
      "marginLeft": "6",
      "preventHorizontalStretch": "true",
      "verticalAlign": "middle"
    }
  },
  "price#desktop": {
    "props": {
      "textAlign": "right"
    }
  },
  "flex-layout.col#remove-button.desktop": {
    "children": ["remove-button"],
    "props": {
      "marginLeft": "6",
      "verticalAlign": "middle"
    }
  },
  "flex-layout.row#message.desktop": {
    "children": ["message#desktop"],
    "props": {
      "marginTop": "4"
    }
  },
  "message#desktop": {
    "props": {
      "layout": "cols"
    }
  },
  "product-list-content-mobile": {
    "children": ["flex-layout.row#list-row.mobile"]
  },
  "flex-layout.row#list-row.mobile": {
    "children": [
      "flex-layout.col#image.mobile",
      "flex-layout.col#main-container.mobile"
    ],
    "props": {
      "fullWidth": true,
      "paddingBottom": "6",
      "paddingTop": "5",
      "colSizing": "auto",
      "preserveLayoutOnMobile": "true"
    }
  },
  "flex-layout.col#image.mobile": {
    "children": ["product-list-image"],
    "props": {
      "marginRight": "5"
    }
  },
  "flex-layout.col#main-container.mobile": {
    "children": [
      "flex-layout.row#top.mobile",
      "flex-layout.row#quantity-selector.mobile",
      "flex-layout.row#unit-price.mobile",
      "flex-layout.row#price.mobile",
      "flex-layout.row#message.mobile"
    ],
    "props": {
      "width": "grow"
    }
  },
  "flex-layout.row#top.mobile": {
    "children": [
      "flex-layout.col#product-description",
      "flex-layout.col#remove-button.mobile"
    ],
    "props": {
      "colSizing": "auto",
      "preserveLayoutOnMobile": "true"
    }
  },
  "flex-layout.row#quantity-selector.mobile": {
    "children": ["quantity-selector"],
    "props": {
      "marginTop": "5",
      "preventHorizontalStretch": "true"
    }
  },
  "flex-layout.row#unit-price.mobile": {
    "children": ["unit-price"],
    "props": {
      "marginTop": "3"
    }
  },
  "flex-layout.row#price.mobile": {
    "children": ["price#mobile"],
    "props": {
      "marginTop": "5",
      "preventHorizontalStretch": "true"
    }
  },
  "price#mobile": {
    "props": {
      "textAlign": "left"
    }
  },
  "flex-layout.col#remove-button.mobile": {
    "children": ["remove-button"],
    "props": {
      "marginLeft": "3"
    }
  },
  "flex-layout.row#message.mobile": {
    "children": ["message#mobile"],
    "props": {
      "marginTop": "3"
    }
  },
  "message#mobile": {
    "props": {
      "layout": "rows"
    }
  }
}

The default implementation means that whenever you declare the product-list block in your store, you are actually telling your theme to render the above json behind the scenes.

In order to customize the product-list configuration, copy the code above, paste it, and change it as you wish.

Block name	Description
`product-list`	Top level block that must be declared in the `minicart-product-list` block to render a default detailed list with all products added to the shopping cart.
`product-list-content-desktop`	Creates the product list layout for desktop devices.
`product-list-content-mobile`	Creates the product list layout for mobile devices.
`message`	Renders a message about the product availability.
`product-name`	Renders the product names.
`product-reference`	Renders the product reference information.
`price`	Renders the product prices.
`unit-price`	Renders the price for each unit of the product added to the cart.
`product-list-image`	Renders the product images.
`product-brand`	Renders the product brands.
`product-variations`	Renders the product variations.
`product-quantity-label`	Renders a product label that displays the number of items added to the cart.
`quantity-selector`	Renders a selector that allows users to choose how many units of a product they want to add to the cart.
`remove-button`	Renders a button that allows users to remove a product from the list.

`minicart-product-list` props

Prop name	Type	Description	Default value
`splitItem`	`boolean`	Determines whether products with attachments should be split and treated as individual items (`true`) or as a single item (`false`) when their quantity is increased in the minicart.	`false`

`product-list` props

Prop name	Type	Description	Default value
`itemCountMode`	`enum`	Quantity badge behavior when displaying the total number of items added in Minicart. Possible values are: `total` (the quantity badge displays the number of items added to the cart), `distinct` (the quantity badge only displays the number of different products added to the cart), `totalAvailable` (the quantity badge displays the number of available items added to the cart), and `distinctAvailable` (the quantity badge only displays the number of different and available products added to the cart).	`distinct`
`lazyRenderHeight`	`number`	The height (px) of each item loading element.	`100`
`lazyRenderOffset`	`number`	The distance (px) that each item should be from the viewport at the time of its rendering.	`300`

`message` props

Prop name	Type	Description	Default value
`layout`	`enum`	Position of the availability message in the list. Possible values are: `rows` (displaying the message in the product row) or `cols` (displaying the message in the product column).	`cols`

`price` props

Prop name	Type	Description	Default value
`textAlign`	`string`	Position of the product's price in the list.	`left`
`showListPrice`	`boolean`	Whether the product prices should be displayed in the list: (`true`) or (`false`).	`true`

`unit-price` props

Prop name	Type	Description	Default value
`textAlign`	`string`	Position of the product's unit price in the list.	`left`
`unitPriceType`	`enum`	Defines whether the price type should be displayed. Possible values are: `sellingPrice` or `price`	`price`
`unitPriceDisplay`	`enum`	Defines when the unit price should be displayed. Possible values are: `always` (unit price is always displayed) or `default` (unit price is only displayed when the number of products is greater than one).	`default`
`displayUnitListPrice`	`enum`	Defines whether the product list price should be displayed. Possible values are: `showWhenDifferent` (the list price is displayed when it is different from the regular price), and `notShow` (the list price is never displayed).	`notShow`

`product-list-image` props

Prop name	Type	Description	Default value
`width`	`number`	Product image width (in pixels).	`96`

`product-reference` props

Prop name	Type	Description	Default value
`identifierLabel`	`string`	Text label to be displayed to the left of the product reference value.	`undefined`
`identifyOption`	`enum`	Desired product reference data, i.e., product identifier, to be displayed. Possible options are: `ProductId`, `ProductSkuItemId`, `ProductReferenceId`, and `ProductSkuReferenceId`.	`ProductReferenceId`

`remove-button` props

Prop name	Type	Description	Default value
`variation`	`enum`	Variation for the button's visual prominence based on the VTEX Styleguide. Possible values are: `primary`, `secondary`, `tertiary`, `inverted-tertiary`, `danger`, and `danger-tertiary`.	`danger`
`displayMode`	`enum`	Defines how the remove button should be displayed. Possible values are: `icon-button` (renders an icon button), and `text-button` (renders a text message button). If you want to create a modal in the remove button, use the `icon-button` value.	`icon-button`

`quantity-selector` props

Prop name	Type	Description	Default value
`mode`	`enum`	Type of quantity selector input. Possible values are `default`, and `stepper`. In the default mode, the quantity stepper will initially render a dropdown component, and after the quantity exceeds 10, it will switch to an input. The stepper mode will always render a numeric stepper component.	`default`
`quantitySelectorStep`	`enum`	Defines how the number of products that have unitMultiplier will work. Possible values are: `singleUnit` (the quantity will be not affected with the unitMultiplier), and `unitMultiplier` (the quantity will be affected with the unitMultiplier).	`unitMultiplier`

Customization

To apply CSS customizations to this and other blocks, follow the instructions in Using CSS Handles for store customization.

CSS Handles
`availabilityMessageContainer`
`availabilityMessageTextContainer`
`availabilityMessageText`
`productBrandName`
`productImageAnchor`
`productImageContainer`
`productImage`
`productListAvailableItemsMessage`
`productListItem`
`productListUnavailableItemsMessage`
`productName`
`productPriceContainer`
`productPriceCurrency`
`productPrice`
`productQuantityLabel`
`productIdentifier`
`productIdentifierValue`
`productIdentifierLabelValue`
`productVariationsContainer`
`productVariationsItem`
`quantityDropdownContainer`
`quantityDropdownMobileContainer`
`quantityInputContainer`
`quantityInputMobileContainer`
`quantitySelectorContainer`
`quantitySelectorWrapper`
`quantitySelectorButton`
`quantitySelectorDecrease`
`quantitySelectorIncrease`
`removeButtonContainer`
`item`
`removeButton`
`unitPriceContainer`
`unitListPrice`
`unitPriceMeasurementUnit`
`unitPricePerUnitCurrency`

Contributors ✨

Thanks goes to these wonderful people:

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

Name		Name	Last commit message	Last commit date
Latest commit History 517 Commits
.github		.github
.vtex		.vtex
docs		docs
messages		messages
react		react
store		store
styles/css		styles/css
.all-contributorsrc		.all-contributorsrc
.eslintignore		.eslintignore
.eslintrc		.eslintrc
.gitignore		.gitignore
.prettierrc		.prettierrc
.vtexignore		.vtexignore
CHANGELOG.md		CHANGELOG.md
crowdin.yml		crowdin.yml
manifest.json		manifest.json
package.json		package.json
yarn.lock		yarn.lock

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Product List

Configuration

Advanced configuration

`minicart-product-list` props

`product-list` props

`message` props

`price` props

`unit-price` props

`product-list-image` props

`product-reference` props

`remove-button` props

`quantity-selector` props

Customization

Contributors ✨

About

Releases 83

Packages

Contributors 37

Languages

vtex-apps/product-list

Folders and files

Latest commit

History

Repository files navigation

Product List

Configuration

Advanced configuration

minicart-product-list props

product-list props

message props

price props

unit-price props

product-list-image props

product-reference props

remove-button props

quantity-selector props

Customization

Contributors ✨

About

Topics

Resources

Stars

Watchers

Forks

Releases 83

Packages 0

Contributors 37

Languages

`minicart-product-list` props

`product-list` props

`message` props

`price` props

`unit-price` props

`product-list-image` props

`product-reference` props

`remove-button` props

`quantity-selector` props

Packages