RoverCore BreadCrumbs

This small library provides a service that makes it easy to add and customize breadcrumbs. The idea is to allow you to create a simple list of breadcrumbs using this service that you can render using a component. What's nice about this approach is that you can add the entire breadcrumb trail in an MVC action method and include the component in your shared _layout.cshtml page.

Usage

Install

Install the package using NuGet
Install-Package RoverCore.BreadCrumbs

Initialize

After you have setup your breadcrumbs you must add the breadcrumbs service:

services.AddScoped<IBreadCrumbService, BreadCrumbService>();

Update your Layout

Update your Shared/_Layout.cshtml and call the BreadCrumbs ViewComponent wherever you want the breadcrumbs to appear.

@(await Component.InvokeAsync<BreadCrumbsViewComponent>())

Adding breadcrumbs

Include the IBreadCrumbService dependency service in your controller.

public class DashboardController : Controller { private readonly IBreadCrumbService _breadcrumbs; public HomeController (IBreadCrumbService breadcrumbs) { _breadcrumbs = breadcrumbs; } public IActionResult Index() { _breadcrumbs.StartAtAction("Dashboard", "Index", "Dashboard", new { Area = "Admin"}) .Then("Home"); return View(); } ... }

Building your trail

There are a number of helpful extension methods that help you build your full breadcrumb trail fluently. See the following:

public static IBreadCrumbService StartAt(this IBreadCrumbService breadCrumbService, string title) public static IBreadCrumbService StartAt(this IBreadCrumbService breadCrumbService, string title, string url) public static IBreadCrumbService StartAtAction(this IBreadCrumbService breadCrumbService, string title, string? action = default, string? controller = default, object? values = default, PathString? pathBase = default, FragmentString fragment = default, LinkOptions? options = default) public static IBreadCrumbService StartAtPage(this IBreadCrumbService breadCrumbService, string title, string? page = default, string? handler = default, object? values = default, PathString? pathBase = default, FragmentString fragment = default, LinkOptions? options = default) public static IBreadCrumbService Then(this IBreadCrumbService breadCrumbService, string title) public static IBreadCrumbService Then(this IBreadCrumbService breadCrumbService, string title, string url) public static IBreadCrumbService ThenAction(this IBreadCrumbService breadCrumbService, string title, string? action = default, string? controller = default, object? values = default, PathString? pathBase = default, FragmentString fragment = default, LinkOptions? options = default) public static IBreadCrumbService ThenPage(this IBreadCrumbService breadCrumbService, string title, string? page = default, string? handler = default, object? values = default, PathString? pathBase = default, FragmentString fragment = default, LinkOptions? options = default)

Overriding the default look

Create a directory in your project at the path Views/Shared/Components/BreadCrumbs (in your views/shared folder create a Components subdirectory and then a BreadCrumbs subdirectory). Copy the Views/Shared/Components/BreadCrumbs/Default.cshtml file from this project into that directory and customize how you wish.