Prints a list of product bundles set as visible in a product category.

Description

Product bundles can be set as visible in a selected product category in the product card's Product bundles tab via the Publish menu.

To print a list of product bundles for a category, use the {Bundles} tag's category attribute.

For more information about product bundles, see also our user guide.

See also detailed instructions on how to implement product bundles in the online store's theme.

Syntax

{CategoryBundles(
    classes: string,
    filters: string,
    helper: string,
    limit: int,
    product: int,
    sort: string,
    type: string
)}

Scope

Required scope: tuoteryhmä

Scope in helper attribute: tuotepaketti

The required scope is always set in the following templates:

Templates
Product list
Display window
Front page

Attribuutit

classes:

Class names that are given to every list element.

Allowed values: class names as strings.

Use space characters to separate the classes that are to be given to the same element. Use pipes to separate the classes that are to be given to different list elements.

E.g. classes:'ekaLuokka tokaLuokka | jokaToisenLuokka jokaToisenTokaLuokka'

See also detailed instructions on how to define list class names.

filters:

Sets filters for displaying on the list only those product bundles that meet certain criteria.

Allowed values: 'featured' (fetches only the product bundles that were marked as featured)

E.g. filters: 'featured'

helper:

Defines the content and output format of a single list element.

Allowed values: the Interface and HTML markup that define the output's markup and content.

The helper attribute can be used in two ways:

  1. you can indicate the desired markup directly as the attribute's value, or
  2. you can indicate a reference to a file with the desired markup as the attribute's value.

    The reference should be indicated in relation to the theme's root directory.

See also detailed instructions on using the helper attribute.

limit:

Sets the maximum length limit to the list to be printed.

Allowed values:integers

E.g. limit:3

product:

Fetches only those product bundles that contain the product with the indicated ID number.

Allowed values:integers

E.g. product:1

sort:

Defines how a list should be sorted.

Allowed values:

  • 'name_asc': in alphabetical order based on names (A-Z)
  • 'name_desc': in reverse alphabetical order based on names (Z-A)
  • 'released_asc': date added (oldest first)
  • 'released_desc': date added (newest first)
  • 'random': random order
  • 'sales_asc': least often sold items first
  • 'sales_desc': best-selling items first
type:

Defines the list's output format.

The attribute is used only if the helper attribute hasn't been set. In such a case, the type attribute doesn't have to be set separately, as it is enabled automatically.

Allowed values: 'normal'

after/before:

By using the after and before attributes you can define content that is output either after or before the tag's output.

Allowed values:The HTML and Interface markup

E.g.

  • before: '<p>Tämä merkkaus näkyy ennen tagin omaa sisältöä.</p>'
  • after: '<p>Tämä taas näkyy tagin oman sisällön jälkeen.</p>'

If the tag does not produce any content, neither the content of the after and before attributes will be output.

escape:

Adds an escape character before quotation marks in the output.

The attribute makes it easier to process the tag-produced content when using JavaScript.

Allowed values:true/false. The default value is false.

or:

Defines alternative content that is displayed if the tag itself does not produce any content.

Allowed values:The HTML and Interface markup

E.g. or:'Sisältöä ei löytynyt.'