{"id":13466335,"url":"https://github.com/Blazored/Menu","last_synced_at":"2025-03-25T21:32:01.939Z","repository":{"id":47591107,"uuid":"174708998","full_name":"Blazored/Menu","owner":"Blazored","description":"A JavaScript free menu library for Blazor and Razor Components applications.","archived":false,"fork":false,"pushed_at":"2024-09-03T20:59:13.000Z","size":4358,"stargazers_count":177,"open_issues_count":6,"forks_count":32,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-25T07:11:43.674Z","etag":null,"topics":["blazor","blazored","hacktoberfest","menu","menu-navigation","menubuilder","menus","nuget","razor","razor-components","webassembly"],"latest_commit_sha":null,"homepage":"https://blazored.github.io/Menu","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Blazored.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["chrissainty"]}},"created_at":"2019-03-09T15:08:57.000Z","updated_at":"2024-11-09T21:51:55.000Z","dependencies_parsed_at":"2024-10-29T19:04:48.945Z","dependency_job_id":null,"html_url":"https://github.com/Blazored/Menu","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Blazored%2FMenu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Blazored%2FMenu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Blazored%2FMenu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Blazored%2FMenu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Blazored","download_url":"https://codeload.github.com/Blazored/Menu/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245414549,"owners_count":20611367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["blazor","blazored","hacktoberfest","menu","menu-navigation","menubuilder","menus","nuget","razor","razor-components","webassembly"],"created_at":"2024-07-31T15:00:42.605Z","updated_at":"2025-03-25T21:32:01.904Z","avatar_url":"https://github.com/Blazored.png","language":"C#","funding_links":["https://github.com/sponsors/chrissainty"],"categories":["Libraries \u0026 Extensions"],"sub_categories":["Components"],"readme":"# Blazored Menu\n\nA JavaScript free menu library for Blazor and Razor Components applications.\n\n[![Build \u0026 Test Main](https://github.com/Blazored/Menu/actions/workflows/ci-main.yml/badge.svg)](https://github.com/Blazored/Menu/actions/workflows/ci-main.yml)\n\n[![Nuget](https://img.shields.io/nuget/v/blazored.menu.svg)](https://www.nuget.org/packages/Blazored.Menu/)\n\n![Screenshot of component in action](screenshot.png)\n\n## Getting Setup\nYou can install the package via the nuget package manager just search for *Blazored.Menu*. You can also install via powershell using the following command.\n\n```powershell\nInstall-Package Blazored.Menu\n```\n\nOr via the dotnet CLI.\n\n```bash\ndotnet add package Blazored.Menu\n```\n\n### Add reference to style sheet\nAdd the following line to the `head` tag of your `index.html` (Blazor WebAssembly App) or `_Host.cshtml` (Blazor Server app).\n\n```\n\u003clink href=\"_content/Blazored.Menu/blazored-menu.css\" rel=\"stylesheet\" /\u003e\n```\n\n### Add Imports\nAdd the following to your *_Imports.razor*\n\n```csharp\n@using Blazored.Menu\n```\n\n## Usage\nBlazored Menu allows menus to be built either using markup or dynamically, using the `MenuBuilder`.\n\n### Building a menu with markup\nYou can build your menus using the following components.\n\n- BlazoredMenu\n- BlazoredMenuItem\n- BlazoredSubMenu\n\nFor example.\n\n```html\n\u003cBlazoredMenu\u003e\n  \u003cBlazoredMenuItem\u003e\n    \u003cNavLink href=\"/\" Match=\"NavLinkMatch.All\"\u003eHome\u003c/NavLink\u003e\n  \u003c/BlazoredMenuItem\u003e\n  \u003cBlazoredSubMenu Header=\"Sub Menu\"\u003e\n        \u003cMenuTemplate\u003e\n            \u003cBlazoredMenuItem\u003e\n                \u003cNavLink href=\"counter\"\u003eCounter\u003c/NavLink\u003e\n            \u003c/BlazoredMenuItem\u003e\n        \u003c/MenuTemplate\u003e\n    \u003c/BlazoredSubMenu\u003e\n    \u003cBlazoredMenuItem\u003e\n        \u003cNavLink href=\"fetchdata\"\u003eFetch data\u003c/NavLink\u003e\n    \u003c/BlazoredMenuItem\u003e\n\u003c/BlazoredMenu\u003e\n```\n\nYou can also specify your own template for sub menu headers like so.\n\n```html\n\u003cBlazoredMenu\u003e\n  \u003cBlazoredMenuItem\u003e\n    \u003cNavLink href=\"/\" Match=\"NavLinkMatch.All\"\u003eHome\u003c/NavLink\u003e\n  \u003c/BlazoredMenuItem\u003e\n  \u003cBlazoredSubMenu Header=\"Sub Menu\"\u003e\n        \u003cHeaderTemplate\u003e\n            \u003ci class=\"my-cool-icon-class\"\u003e\u003c/i\u003e Sub Menu\n        \u003c/HeaderTemplate\u003e\n        \u003cMenuTemplate\u003e\n            \u003cBlazoredMenuItem\u003e\n                \u003cNavLink href=\"counter\"\u003eCounter\u003c/NavLink\u003e\n            \u003c/BlazoredMenuItem\u003e\n            \u003cBlazoredMenuItem\u003e\n                \u003cNavLink href=\"fetchdata\"\u003eFetch data\u003c/NavLink\u003e\n            \u003c/BlazoredMenuItem\u003e\n        \u003c/MenuTemplate\u003e\n    \u003c/BlazoredSubMenu\u003e\n\u003c/BlazoredMenu\u003e\n```\n\n_This feature is currently only available when building menus with markup._\n\nYou can also supply your own CSS classes to each of the 3 components\n- BlazoredMenu\n- BlazoredMenuItem\n- BlazoredSubMenu\n\nBy setting the `Css` parameter.\n\n```html\n\u003cBlazoredMenu Css=\"custom-menu-css\"\u003e\n  \u003cBlazoredMenuItem Css=\"custom-menuitem-css\"\u003e\n    \u003cNavLink href=\"/\" Match=\"NavLinkMatch.All\"\u003eHome\u003c/NavLink\u003e\n  \u003c/BlazoredMenuItem\u003e\n  \u003cBlazoredSubMenu Header=\"Sub Menu\" Css=\"custom-submenu-css\"\u003e\n        \u003cHeaderTemplate\u003e\n            \u003ci class=\"my-cool-icon-class\"\u003e\u003c/i\u003e Sub Menu\n        \u003c/HeaderTemplate\u003e\n        \u003cMenuTemplate\u003e\n            \u003cBlazoredMenuItem\u003e\n                \u003cNavLink href=\"counter\"\u003eCounter\u003c/NavLink\u003e\n            \u003c/BlazoredMenuItem\u003e\n            \u003cBlazoredMenuItem\u003e\n                \u003cNavLink href=\"fetchdata\"\u003eFetch data\u003c/NavLink\u003e\n            \u003c/BlazoredMenuItem\u003e\n        \u003c/MenuTemplate\u003e\n    \u003c/BlazoredSubMenu\u003e\n\u003c/BlazoredMenu\u003e\n```\n\n\n### Building a menu dynamically using the MenuBuilder\nIf you prefer you can use the `MenuBuilder` to create your menus using C#. The `MenuBuilder` exposes two methods `AddItem` and `AddSubMenu`. You can build the same menu from the markup example as follows.\n\n```html\n\u003cBlazoredMenu MenuBuilder=\"@MenuBuilder\" /\u003e\n\n@functions {\n    MenuBuilder MenuBuilder = new MenuBuilder();\n\n    protected override void OnInit()\n    {\n        MenuBuilder.AddItem(1, \"Home\", \"/\")\n                   .AddSubMenu(2, \"Sub Menu\", new MenuBuilder().AddItem(1, \"Counter\", \"counter\")\n                   .AddItem(3, \"FetchData\", \"fetchdata\");\n    }\n}\n```\n\n### MenuBuilder Options\nWhen using the `MenuBuilder` you have a couple of extra options available via the `AddItem` and `AddSubMenu` methods. \n\n- IsEnabled (default: true)\n- IsVisible (default: true)\n\nYou can use these options to manipulate your menu items. `IsVisible`, if set to `false`, will mark your menu items as `display: none` making them invisible. Setting `IsEnabled` to `false` will render the item in a non-interactive state.\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBlazored%2FMenu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBlazored%2FMenu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBlazored%2FMenu/lists"}