From f56b06e46f4608fcf14da9ce52e66a4d006c7932 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A1rbara=20Celi?= <112641072+barbara-celi@users.noreply.github.com> Date: Tue, 29 Oct 2024 12:55:29 -0300 Subject: [PATCH 1/3] Update README.md --- docs/README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/README.md b/docs/README.md index 3d7cf46..d3c24ce 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,19 +2,13 @@ # Menu - - -[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors) - - - -VTEX Menu is a store component that displays a bar containing links and dropdown submenus. +The Menu component displays a navigation bar with links and dropdown submenus. It can be configured to display internal or external links and supports both category-based and custom menu items. ![menu-app](https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-menu-0.png) ## Configuration -1. Import the menu app to your dependencies as `manifest.json`. For example: +1. Add the app to your store theme's dependencies in the `manifest.json`. ```json "dependencies": { @@ -98,7 +92,9 @@ _Example:_ } ``` -You can define a submenu for a menu item: +### Adding a submenu + +You can define a submenu by adding the `submenu` block to a `menu-item`: ```jsonc "menu-item#shop": { @@ -128,9 +124,11 @@ You can define a submenu for a menu item: ```
-The Menu block has no prerequisite children. Therefore, Menu block implementations do not need to have any blocks declared within them to function properly. +The Menu block doesn't require any specific child blocks to function
+## `menu-item` props + The available `menu-item` block props are as follows: | Prop name | Type | Description | Default value | @@ -142,9 +140,9 @@ The available `menu-item` block props are as follows: | `iconProps` | `IconProps` | Icon props | `undefined` | | `onMountBehavior` | `enum` | Whether the submenu should always be automatically displayed when its parent is hovered/clicked on (`open`) or (`close`). | `closed` | | `itemProps` | `CategoryItem` or `CustomItem` | Item props | `undefined` | -| `classes` | `CustomCSSClasses` | Used to override default CSS handles. To better understand how this prop works, we recommend reading about it [here](https://github.com/vtex-apps/css-handles#usecustomclasses). Please note that this is only useful when importing this block as a React component. | `undefined` | +| `blockClass` | `CustomCSSClasses` | Used to override default CSS handles. To learn how this prop works, we recommend reading about it [here](https://github.com/vtex-apps/css-handles#usecustomclasses). Please note that this is only useful when importing this block as a React component. | `undefined` | -- For icons in the menu items: +### Icon props | Prop name | Type | Description | Default value | | ----------------- | --------- | --------------------------------------- | ------------- | @@ -155,14 +153,14 @@ The available `menu-item` block props are as follows: | `activeClassName` | `string` | Icon classname when `isActive` is true | N/A | | `mutedClassName` | `string` | Icon classname when `isActive` is false | N/A | -- For category-related menu items: +### Category-specific props | Prop name | Type | Description | Default value | | ------------ | -------- | ---------------- | ------------- | | `categoryId` | `number` | Item category ID | N/A | | `text` | `string` | Menu item text | N/A | -- For customized items: +### Custom item props | Prop name | Type | Description | Default value | | ---------- | --------- | ----------------------------------------------- | ------------- | @@ -172,7 +170,7 @@ The available `menu-item` block props are as follows: | `tagTitle` | `string` | Menu item tag | N/A | | `text` | `string` | Menu item text | N/A | -#### Customization +## Customization To apply CSS customizations to this and other blocks, please follow the instructions in [Using CSS Handles for store customization](https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization). From 4585f479b3dd3506a33773e98d47c2f4f68a0fca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A1rbara=20Celi?= <112641072+barbara-celi@users.noreply.github.com> Date: Tue, 29 Oct 2024 12:57:58 -0300 Subject: [PATCH 2/3] Adding all contributors in README.md --- docs/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/README.md b/docs/README.md index d3c24ce..0f7ee8e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,12 @@ # Menu + + +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors) + + + The Menu component displays a navigation bar with links and dropdown submenus. It can be configured to display internal or external links and supports both category-based and custom menu items. ![menu-app](https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-menu-0.png) From 45c83af6272bb0bf4bf257cc24139a94a5d7bc14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A1rbara=20Celi?= <112641072+barbara-celi@users.noreply.github.com> Date: Tue, 29 Oct 2024 13:26:44 -0300 Subject: [PATCH 3/3] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index de5db8a..9e653fc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +### Fixed + +- Fix `blockClass` prop name. + ## [2.35.2] - 2023-04-25 ### Fixed