Product list
The product list object represents a product list content area on the site.
List of available attributes
- any_product_on_sale?
- columns
- content_settings
- design_settings
- id
- item_height
- item_width
- layout_type
- mask_content_overflow?
- mobile_columns
- product_categories
- product_categories_as_hash
- product_count
- products
- show_cart_button?
- show_discount_label?
- show_discount_percentage?
- show_navigation_buttons?
- show_price?
- show_product_alt_image?
- show_product_filters?
- show_product_modal?
- sort_order
any_product_on_sale?
Returns true if any product in the product list is on sale. Returns false otherwise.
columns
Returns the number of columns used to display the list on desktop.
content_settings
Returns the product list's content settings as an object.
design_settings
Returns the product list's design settings as an object.
id
Returns the product list's unique ID.
item_height
Returns the list item height used with the catalogue layout.
item_width
Returns the list item width used with the catalogue layout.
layout_type
Returns the product list layout. Values are catalogue, grid, list or masonry.
mask_content_overflow?
Returns true if content overflowing the product list container is masked. Returns false otherwise.
mobile_columns
Returns the number of columns used to display the list on mobile.
product_categories
Returns the unique categories of products in the list as an array of Category objects, sorted by name.
product_categories_as_hash
Returns the unique product categories as an array of objects containing each category's id and name, sorted by name.
product_count
Returns the maximum number of products displayed in the product list.
products
Returns an array of Product objects in the list. In public mode, unpublished products are excluded.
show_cart_button?
Returns true if an Add to cart button is displayed for list items. Returns false otherwise.
show_discount_label?
Returns true if discount labels are shown for products with sale prices. Returns false otherwise.
show_discount_percentage?
Returns true if the discount percentage is shown on the discount label when available. Returns false otherwise.
show_navigation_buttons?
Returns true if navigation buttons are shown with the catalogue layout. Returns false otherwise.
show_price?
Returns true if product prices are displayed. Returns false otherwise.
show_product_alt_image?
Returns true if the alternate product image is shown. Returns false otherwise.
show_product_filters?
Returns true if product filters are displayed above the product list. Returns false otherwise.
show_product_modal?
Returns true if product details are displayed in a modal. Returns false otherwise.
sort_order
Returns the product sort order. Values are name-asc, name-desc, price_min-asc, price_min-desc, created_at-asc, created_at-desc or on_sale-desc.