📢 Don't fork this project. Use, contribute, or open issues through Store Discussion.

VTEX Menu

All Contributors

VTEX Menu is a store component responsible for displaying a bar containing links and drop-down sub-menus.

menu-app

Configuration

  1. Import the menu's app to your dependencies as manifest.json, for example:
  dependencies: {
    "vtex.menu": "2.x"
  }
  1. Add the vtex.menu@2.x:menu block to the store header template.

  2. To build the store's menu options, you need to configure the menu-item blocks. These can be declared in two different ways in vtex.menu@2.x:menu: as children or as props. The advantage of this latest menu-item configuration compared is that Site Editor can be used to edit the blocks.

Example:

"vtex.menu@2.x:menu#websites": {
  "children": [
    "menu-item#shop",
    "menu-item#about-us"
  ]
},
"menu-item#shop": {
  "props": {
    "id": "menu-item-shop",
    "type": "custom",
    "highlight": false,
    "itemProps": {
      "type": "internal",
      "href": "#",
      "noFollow": false,
      "tagTitle": "Shop",
      "text": "Shop"
    },
    "iconProps": {
      "id": "bnd-logo",
      "size": 16,
      "viewBox": "0 0 16 16",
      "activeClassName": "rebel-pink",
      "mutedClassName": "c-action-primary"
    },
    "iconToTheRight": true
  }
}

Example:

"vtex.menu@2.x:menu#websites": {
  "props": {
    "items": [
      {
        "id": "menu-item-shop",
        "type": "custom",
        "iconId": null,
        "highlight": false,
        "itemProps": {
          "type": "internal",
          "href": "#",
          "noFollow": false,
          "tagTitle": "Shop",
          "text": "Shop"
        }
      },
      {
        "id": "menu-item-about-us",
        "type": "custom",
        "iconId": null,
        "highlight": false,
        "itemProps": {
          "type": "internal",
          "href": "/about-us",
          "noFollow": false,
          "tagTitle": "about-us",
          "text": "About Us"
        }
      }
    ]
  }
}

You can define a submenu for a menu-item:

"menu-item#shop": {
  "props": {
    "type": "custom",
    "highlight": false,
    "itemProps": {
      "type": "internal",
      "href": "#",
      "noFollow": false,
      "tagTitle": "Shop",
      "text": "Shop"
    },
  },
  "blocks": ["vtex.menu@2.x:submenu#shop"] // Defining a submenu
},
"vtex.menu@2.x:submenu#shop": {
  "children": [
    "vtex.menu@2.x:menu#submenushop"
  ]
},
"vtex.menu@2.x:menu#submenushop": {
  "children": [
    "menu-item#shop"
  ]
}
The Menu block has no prerequisite children. Therefore, any menu block implementation does not need to have any blocks declared within it to properly function.

The available menu-item block props are as follows:

Prop nameTypeDescriptionDefault value
typeStringMenu item type, either category or customcaterogy
idStringmenu item IDN/A
highlightbooleanWhether the item has highlightN/A
iconPositionStringIcon position relative to the menu item text. Either to the left or rightleft
iconPropsIconPropsIcon propsN/A
itemPropsCategoryItem or CustomItemItem propsN/A
  • For icons in the menu items:
Prop nameTypeDescriptionDefault value
idStringIcon IDN/A
isActivebooleanWhether the item is active or nottrue
sizenumberIcon size16
viewBoxStringIcon view box0 0 16 16
activeClassNameStringIcon classname when isActive is trueN/A
mutedClassNameStringIcon classname when isActive is falseN/A
  • For category related menu items:
Prop nameTypeDescriptionDefault value
categoryIdnumberItem category IDN/A
textStringMenu item textN/A
  • For customized items:
Prop nameTypeDescriptionDefault value
typeStringMenu item type, either internal or externalinternal
hrefStringLink to where the menu item leadsN/A
noFollowbooleanNo follow attributeN/A
tagTitleStringMenu item tagN/A
textStringMenu item textN/A

Customization

In order to apply CSS customizations on this and other blocks, follow the instructions given in the recipe on Using CSS Handles for store customization.

CSS Handle
container
linkLeft
linkMiddle
linkRight
submenuAccordion
submenu
menuItem
menuContainer
styledLink
styledLinkContainer
styledLinkIcon
menuLinkNav
menuLinkDivLeft
menuLinkDivMiddle
menuLinkDivRight
renderLink
menuContainerNav
menuItemInnerDiv
submenuContainer

Contributors

Thanks goes to these wonderful people (emoji key):

Giovana Pereira
Giovana Pereira

💻

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