VTEX Developer Portal

All ContributorsAll Contributors

Category Menu app is a store component that shows a department list of the store on an customizable menu, and this app is used by store theme.

Configuration

  1. Add the app to your theme's dependencies on the manifest.json, for example:
  dependencies: {
    "vtex.category-menu": "2.x"
  }
  1. Add the category-menu block into your theme.
{
  "category-menu": {
    "props": {
      "showAllDepartments": true,
      "showSubcategories": true,
      "menuDisposition": "center",
      "departments": [],
      "sortSubcategories": "name"
    }
  }
}
Prop nameTypeDescriptionDefault Value
showAllDepartmentsBooleanShows all departments category in menutrue
menuDispositionEnumIndicates the disposition of the menu on the screen. Possible values: left, center, rightcenter
showSubcategoriesBooleanDecides if the subcategories will be displayedtrue
departmentsArray(items)List of departments items to be displayed on the menu[]
mobileModeBooleanUse this as true to render the category menu in a sidebarfalse
sortSubcategoriesEnumDetermine how subcategories are sorted. Possible values name

Items:

Prop nameTypeDescription
idNumberThe department Id to be displayed on the menu

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.

CSS Handles
container
departmentLink
departmentList
firstLevelLink
firstLevelLinkContainer
firstLevelList
itemContainer
itemContainer--category
itemContainer--department
menuContainer
secondLevelLink
secondLevelLinkContainer
secondLevelList
section--category
section--department
sidebar
sidebarContainer
sidebarContent
sidebarHeader
sidebarItem
sidebarItemContainer
sidebarOpen
sidebarScrim
submenuItem
submenuList

Contributors ✨

Thanks goes to these wonderful people (emoji key):

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

Updated 5 months ago


Category Menu


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.