{"id":39486605,"url":"https://github.com/vtex-apps/category-menu","last_synced_at":"2026-01-18T05:27:03.450Z","repository":{"id":38272750,"uuid":"128828736","full_name":"vtex-apps/category-menu","owner":"vtex-apps","description":"VTEX Category Menu app","archived":false,"fork":false,"pushed_at":"2025-04-09T17:33:35.000Z","size":2498,"stargazers_count":2,"open_issues_count":7,"forks_count":15,"subscribers_count":48,"default_branch":"master","last_synced_at":"2025-04-09T18:42:28.540Z","etag":null,"topics":["category-menu","hacktoberfest","srv-store-framework","store-framework","vtex-io","xp-developer"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vtex-apps.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-09T20:17:34.000Z","updated_at":"2024-11-25T21:25:34.000Z","dependencies_parsed_at":"2025-03-31T21:24:59.764Z","dependency_job_id":"708a6150-b289-4f30-b8c9-167b55666e15","html_url":"https://github.com/vtex-apps/category-menu","commit_stats":null,"previous_names":[],"tags_count":72,"template":false,"template_full_name":null,"purl":"pkg:github/vtex-apps/category-menu","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fcategory-menu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fcategory-menu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fcategory-menu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fcategory-menu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex-apps","download_url":"https://codeload.github.com/vtex-apps/category-menu/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fcategory-menu/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28530810,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["category-menu","hacktoberfest","srv-store-framework","store-framework","vtex-io","xp-developer"],"created_at":"2026-01-18T05:27:03.367Z","updated_at":"2026-01-18T05:27:03.434Z","avatar_url":"https://github.com/vtex-apps.png","language":"JavaScript","readme":"📢 Use this project, [contribute](https://github.com/vtex-apps/category-menu) to it or open issues to help evolve it using [Store Discussion](https://github.com/vtex-apps/store-discussion).\n\n# Category Menu\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\nThe Category Menu is a store component that displays a list of departments in a configurable menu layout. It helps organize and present categories and subcategories to improve navigation.\n\n![category-menu](https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/docs/vtex-menu-0.png)\n\n## Configuration\n\n1. Add the app to your store theme's dependencies in the `manifest.json`.\n\n```json\n  dependencies: {\n    \"vtex.category-menu\": \"2.x\"\n  }\n```\n\n2. Add the `category-menu` block to your store theme.\n\n```json\n{\n  \"category-menu\": {\n    \"props\": {\n      \"showAllDepartments\": true,\n      \"showSubcategories\": true,\n      \"menuDisposition\": \"center\",\n      \"departments\": [],\n      \"sortSubcategories\": \"name\"\n    }\n  }\n}\n```\n\n### `category-menu` props\n\n| Prop name            | Type           | Description                                                                                     | Default Value |\n| -------------------- | -------------- | ----------------------------------------------------------------------------------------------- | ------------- |\n| `showAllDepartments` | `Boolean`      | Shows all department categories in the menu                                                          | `true`        |\n| `menuDisposition`    | `Enum`         | Indicates the menu's position on the screen. Possible values: `left`, `center`, `right` | `center`      |\n| `showSubcategories`  | `Boolean`      | Defines if the subcategories will be displayed                                                  | `true`        |\n| `departments`        | `Array(items)` | List of department `items` to be displayed on the menu                                         | `[]`          |\n| `mobileMode`         | `Boolean`      | Renders the category menu in a sidebar if set to `true`                                     | `false`       |\n| `sortSubcategories`  | `Enum`         | Determines how subcategories are sorted. Possible value: `name`                                  |               |\n\n### `category-menu` items\n\n| Prop name | Type     | Description                                   |\n| --------- | -------- | --------------------------------------------- |\n| `id`      | `Number` | The department ID to be displayed on the menu |\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions on [Using CSS Handles for store customization](https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles                 |\n| --------------------------- |\n| `container`                 |\n| `departmentLink`            |\n| `departmentList`            |\n| `firstLevelLink`            |\n| `firstLevelLinkContainer`   |\n| `firstLevelList`            |\n| `itemContainer`             |\n| `itemContainer--category`   |\n| `itemContainer--department` |\n| `menuContainer`             |\n| `secondLevelLink`           |\n| `secondLevelLinkContainer`  |\n| `secondLevelList`           |\n| `section--category`         |\n| `section--department`       |\n| `sidebar`                   |\n| `sidebarContainer`          |\n| `sidebarContent`            |\n| `sidebarHeader`             |\n| `sidebarItem`               |\n| `sidebarItemContainer`      |\n| `sidebarOpen`               |\n| `sidebarScrim`              |\n| `submenuItem`               |\n| `submenuList`               |\n\n\u003c!-- DOCS-IGNORE:start --\u003e\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/khrizzcristian\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/43498488?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ekhrizzcristian\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/vtex-apps/category-menu/commits?author=khrizzcristian\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!\n\u003c!-- DOCS-IGNORE:end --\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex-apps%2Fcategory-menu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex-apps%2Fcategory-menu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex-apps%2Fcategory-menu/lists"}