{"id":22751629,"url":"https://github.com/akenoduch/blazor_breadcrumbs","last_synced_at":"2026-05-03T19:31:06.871Z","repository":{"id":267301025,"uuid":"900804347","full_name":"akenoduch/Blazor_Breadcrumbs","owner":"akenoduch","description":"Generic C# Breadcrumb component ","archived":false,"fork":false,"pushed_at":"2024-12-09T14:44:44.000Z","size":150,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T06:42:36.782Z","etag":null,"topics":["blazor","blazor-component","breadcrumb","breadcrumb-navigation","breadcrumbs","csharp","navigation","navigation-component"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/akenoduch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-12-09T13:58:38.000Z","updated_at":"2024-12-09T14:44:57.000Z","dependencies_parsed_at":"2024-12-09T15:36:29.133Z","dependency_job_id":"15c0f7fa-b7a2-462a-9b7b-ff01eb6a3390","html_url":"https://github.com/akenoduch/Blazor_Breadcrumbs","commit_stats":null,"previous_names":["akenoduch/blazor_breadcrumbs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akenoduch%2FBlazor_Breadcrumbs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akenoduch%2FBlazor_Breadcrumbs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akenoduch%2FBlazor_Breadcrumbs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akenoduch%2FBlazor_Breadcrumbs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akenoduch","download_url":"https://codeload.github.com/akenoduch/Blazor_Breadcrumbs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246285666,"owners_count":20752953,"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","blazor-component","breadcrumb","breadcrumb-navigation","breadcrumbs","csharp","navigation","navigation-component"],"created_at":"2024-12-11T05:06:29.077Z","updated_at":"2026-05-03T19:31:06.824Z","avatar_url":"https://github.com/akenoduch.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Blazor Generic Breadcrumb Component\n\nThis repository contains a **Generic Breadcrumb Component** for Blazor applications, enabling breadcrumb navigation to enhance user experience and track navigation history. The component uses `BreadcrumbService` for managing breadcrumb data and integrates with `JSInterop` for cookie-based persistence.\n\n## Features\n\n- **Dynamic Breadcrumb Management:** Tracks navigation changes and updates breadcrumb items dynamically.\n- **Persistence with Cookies:** Stores breadcrumbs in cookies for state retention across sessions.\n- **Customizable UI:** Easily styled breadcrumb interface.\n- **Lightweight Integration:** Requires minimal setup to integrate into Blazor projects.\n\n---\n\n## Components and Files\n\n### **`BreadcrumbService.cs`**\n- Core service that:\n  - Manages breadcrumb states and updates based on navigation events.\n  - Persists breadcrumb data in cookies via `JSInterop`.\n  - Handles breadcrumb truncation for maintaining relevance.\n\n### **`Breadcrumbs.razor`**\n- UI component for rendering the breadcrumb trail.\n- Integrates with `BreadcrumbService` for dynamic updates.\n- Supports customizable breadcrumb items and design.\n\n### **`blazorExtensions.js`**\n- JavaScript utilities for:\n  - Managing cookies (`setCookie`, `getCookie`, `deleteCookie`).\n  - Handling breadcrumb click navigation.\n  - Observing DOM events for the breadcrumb component.\n\n### **Layouts**\n- **`App.razor`**\n  - Entry point to the Blazor application, ensuring proper rendering.\n- **`MainLayout.razor`**\n  - Includes the JavaScript file (`blazorExtensions.js`) and manages layout-level URL updates.\n\n---\n\n## Installation and Setup\n\n1. **Add the `BreadcrumbService` to the DI Container:**\n   ```csharp\n   builder.Services.AddScoped\u003cBreadcrumbService\u003e();\n   ```\n\n2. **Include the JavaScript File in Your Layout:**\n   ```html\n   \u003cscript src=\"js/blazorExtensions.js\"\u003e\u003c/script\u003e\n   ```\n\n3. **Inject the Breadcrumb Component in Your Page:**\n   ```razor\n   @inject BreadcrumbService BreadcrumbService\n\n   \u003cdiv id=\"breadcrumbs\"\u003e\n       \u003cBreadcrumbs /\u003e\n   \u003c/div\u003e\n   ```\n\n4. **Add Breadcrumb Items in Your Page Logic:**\n   ```razor\n   protected override async Task OnInitializedAsync()\n   {\n       await BreadcrumbService.AddBreadcrumb(\"Breadcrumb Title\", NavigationManager.Uri);\n   }\n   ```\n\n---\n\n## Styling\n\nThe breadcrumb component is styled using the provided CSS within `Breadcrumbs.razor`. Customize it as needed:\n```css\n.breadcrumb {\n    padding: 0.75rem 1rem;\n    background-color: transparent;\n}\n\n.breadcrumb-item a {\n    text-decoration: none;\n}\n\n.breadcrumb-item.active {\n    font-weight: bold;\n}\n```\n\n---\n\n## JavaScript Integration\n\nThe JavaScript utilities in `blazorExtensions.js` provide cookie management and event handling. Key functions:\n- **Set a Cookie:**\n  ```javascript\n  blazorExtensions.setCookie(\"key\", \"value\", 365);\n  ```\n- **Get a Cookie:**\n  ```javascript\n  blazorExtensions.getCookie(\"key\");\n  ```\n- **Delete a Cookie:**\n  ```javascript\n  blazorExtensions.deleteCookie(\"key\");\n  ```\n\n---\n\n## Usage Example\n\n```razor\n@inject BreadcrumbService BreadcrumbService\n\n@if (ShowBreadcrumbs)\n{\n    \u003cBreadcrumbs /\u003e\n}\n\nprotected override async Task OnInitializedAsync()\n{\n    await BreadcrumbService.AddBreadcrumb(\"Home\", \"/\");\n    await BreadcrumbService.AddBreadcrumb(\"Dashboard\", \"/dashboard\");\n}\n```\n\n---\n\n## Roadmap\n\n- [ ] Add support for custom separators between breadcrumb items.\n- [ ] Improve accessibility with ARIA roles and attributes.\n- [ ] Provide advanced customization options for the breadcrumb UI.\n\n---\n\n## Contributing\n\nFeel free to open issues and submit pull requests for improvements or bug fixes. Contributions are welcome!\n\n---\n\n## Acknowledgments\n\nThanks to the Blazor and .NET community for their resources and contributions, enabling seamless development of this component.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakenoduch%2Fblazor_breadcrumbs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakenoduch%2Fblazor_breadcrumbs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakenoduch%2Fblazor_breadcrumbs/lists"}