Getting Started with Blazor Breadcrumb in Blazor Web App
20 Feb 20244 minutes to read
This section briefly explains about how to include Blazor Breadcrumb component in your Blazor Web App using Visual Studio.
Prerequisites
Create a new Blazor Web App
You can create a Blazor Web App using Visual Studio 2022 via Microsoft Templates or the Syncfusion Blazor Extension.
You need to configure the corresponding Interactive render mode and Interactivity location while creating a Blazor Web Application.
Install Syncfusion Blazor Navigations and Themes NuGet in the App
To add Blazor Breadcrumb component in the app, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search and install Syncfusion.Blazor.Navigations and Syncfusion.Blazor.Themes.
If you utilize WebAssembly or Auto render modes in the Blazor Web App need to be install Syncfusion Blazor components NuGet packages within the client project.
Alternatively, you can utilize the following package manager command to achieve the same.
Install-Package Syncfusion.Blazor.Navigations -Version 27.2.2
Install-Package Syncfusion.Blazor.Themes -Version 27.2.2NOTE
Syncfusion Blazor components are available in nuget.org. Refer to NuGet packages topic for available NuGet packages list with component details.
Register Syncfusion Blazor Service
Open ~/_Imports.razor file and import the Syncfusion.Blazor and Syncfusion.Blazor.Navigations namespace .
@using Syncfusion.Blazor
@using Syncfusion.Blazor.NavigationsNow, register the Syncfusion Blazor Service in the ~/Program.cs file of your Blazor Web App.
If you select an Interactive render mode as WebAssembly or Auto, you need to register the Syncfusion Blazor service in both ~/Program.cs files of your Blazor Web App.
....
using Syncfusion.Blazor;
....
builder.Services.AddSyncfusionBlazor();
....Add stylesheet and script resources
The theme stylesheet and script can be accessed from NuGet through Static Web Assets. Include the stylesheet reference in the <head> section and the script reference at the end of the <body> in the ~/Components/App.razor file as shown below:
<head>
....
<link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
</head>
....
<body>
....
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>
</body>NOTE
Check out the Blazor Themes topic to discover various methods (Static Web Assets, CDN, and CRG) for referencing themes in your Blazor application. Also, check out the Adding Script Reference topic to learn different approaches for adding script references in your Blazor application.
Add Syncfusion Blazor Breadcrumb component
Add the Syncfusion Blazor Breadcrumb component in the ~Pages/.razor file. If an interactivity location as Per page/component in the web app, define a render mode at the top of the ~Pages/.razor component, as follows:
@* desired render mode define here *@
@rendermode InteractiveAuto<SfBreadcrumb></SfBreadcrumb>- Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This will render the Syncfusion Blazor Breadcrumb component in your default web browser.
NOTE
Add items to the Blazor Breadcrumb component
To render Breadcrumb component with items use BreadcrumbItem tag directive as like below code example.
@using Syncfusion.Blazor.Navigations
<SfBreadcrumb>
<BreadcrumbItems>
<BreadcrumbItem IconCss="e-icons e-home" Url="https://blazor.syncfusion.com/demos/"/>
<BreadcrumbItem Text="Components" Url="https://blazor.syncfusion.com/demos/datagrid/overview"/>
<BreadcrumbItem Text="Navigations" Url="https://blazor.syncfusion.com/demos/menu-bar/default-functionalities"/>
<BreadcrumbItem Text="Breadcrumb" Url="./breadcrumb/default-functionalities"/>
</BreadcrumbItems>
</SfBreadcrumb>NOTE
Place list of BreadcrumbItem within BreadcrumbItems tag directive.
Enable or disable navigation
Breadcrumb component enables or disables built-in URL navigation based on the EnableNavigation property. By default, the navigation will be enabled when setting the Url property. To prevent Breadcrumb item navigation, set the EnableNavigation property as false in Breadcrumb.