Prints the online store's product category navigation which comprises a list of product categories. The list's contents and format can be freely modified.

Kuvaus

By default, product categories are printed as a <ul> list, which is given class names.

Multiple class names are given to product categories to be printed:

  • The list itself is given the class names Categories and NavigationList. If the product category structure has more than one level, no class names will be printed for the next level lists.
  • If the customer is on a product category page that is included in the navigation, the product category in question will be given the class name Current in the navigation.
  • The product category ID is printed in the format Category-n for every <li> element.
  • For each list's first and last navigation element, the class names FirstNavigationItem and LastNavigationItem are printed respectively.

You can obtain the desired list content and markup by using product category tags in the helper attribute.

Syntaksi

{Categories( brand: int, category: int, parent: int, filters: string, first: boolean, start: int, levels: int, show: string, sort: string, classes: string, helper: string )}

Näkyvyys

Toimii näkyvyydessä: globaali

Näkyvyyshelper-attribuutissa: tuoteryhmä

It is possible to use global visibility tags in any page template and within any tag.

Attribuutit

brand:

This attribute selects only the product categories that contain the selected brands' products to be displayed on the list.

Allowed values: pipe-separated brand ID numbers

E.g. brand:1|2|3

category:

You can use this attribute to manually define which product categories should be printed.

Allowed values: pipe-separated product category ID numbers

E.g. category: '1|2|3'

parent:

Defines the product category whose subcategories are to be printed.

Allowed values: an integer (product category ID)

start:

Defines the product category's hierarchy level from which printing starts.

Allowed values: integers.

E.g. with the value start:2 prints product categories starting from level 2 onwards.

filters:

Defines filters for selecting product categories that should be displayed on a list.

Allowed values:

  • 'featured': prints featured product categories

E.g. filters:'featured'

first:

When necessary, sets a class name in the navigation list. The class name makes it clear that the list is the navigation's or navigation element's first element.

Allowed values: true/false. Default value: true.

levels:

Defines the number of product category levels to be printed. The value 1 prints only the top level or the product categories of the level defined in the start attribute.

Allowed values: integers. Default value: 1.

show:

Defines which product categories to display on the product category list: the store's all categories or rather just the subcategories of the product category selected by the user.

Allowed values:

  • 'active': prints only the subcategories of the product category selected by the user
  • 'all' (default value): prints the complete product category menu
sort:

Sorts the product category list in a desired manner.

Allowed values:

  • 'manual': uses the order defined in the admin panel (default value)
  • 'name_asc': alphabetical order based on product categories' names
  • 'name_desc': reversed alphabetical order
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:'firstClass secondClass | everyOthersClass everyOthersSecondClass'

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

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:

  • you can indicate the desired markup directly as the attribute's value, or
  • 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.

before/after:

With the before and after attributes, you can define content that is output before or after the content produced by the tag.

Allowed values: text that may contain HTML and Interface markup.

E.g.

  • before: '<p>This markup appears before the tag's own content.</p>'.
  • after: '<p>This appears after the tag's own content.</p>'

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

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: text that may contain HTML and Interface markup.

E.g. or:'Content not found.'