Getting Started with Blazor Breadcrumb Component

15 Apr 20265 minutes to read

This section briefly explains about how to include Syncfusion^® Blazor Breadcrumb component in a Blazor WebAssembly App using Visual Studio, Visual Studio Code, and the .NET CLI.

• Visual Studio
• Visual Studio Code
• .NET CLI

Prerequisites

• System requirements for Blazor components

Create a new Blazor App in Visual Studio

Create a Blazor WebAssembly App using Visual Studio via Microsoft Templates or the Syncfusion^® Blazor Extension. For detailed instructions, refer to the Blazor WASM App Getting Started documentation.

Prerequisites

• System requirements for Blazor components

Create a new Blazor App in Visual Studio Code

Create a Blazor WebAssembly App using Visual Studio Code via Microsoft Templates or the Syncfusion^® Blazor Extension. For detailed instructions, refer to the Blazor WASM App Getting Started documentation.

Alternatively, create a WebAssembly application by using the following command in the integrated terminal (Ctrl+`).

Blazor WASM App

dotnet new blazorwasm -o BlazorApp
cd BlazorApp

Prerequisites

Install the latest version of .NET SDK. If the .NET SDK is already installed, determine the installed version by running the following command in a command prompt (Windows), terminal (macOS), or command shell (Linux).

.NET CLI

dotnet --version

Create a Blazor WebAssembly App using .NET CLI

Run the following command to create a new Blazor WebAssembly App in a command prompt (Windows) or terminal (macOS) or command shell (Linux). For detailed instructions, refer to the Blazor WASM App Getting Started documentation.

.NET CLI

dotnet new blazorwasm -o BlazorApp
cd BlazorApp

Install Syncfusion^® Blazor packages

Install Syncfusion.Blazor.Navigations and Syncfusion.Blazor.Themes NuGet packages in your project using the NuGet Package Manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), or the integrated terminal in Visual Studio Code (dotnet add package), or the .NET CLI.

Alternatively, run the following commands in the Package Manager Console to achieve the same.

Package Manager

Install-Package Syncfusion.Blazor.Navigations -Version 33.2.3
Install-Package Syncfusion.Blazor.Themes -Version 33.2.3

NOTE

All Syncfusion Blazor packages are available on nuget.org. See the NuGet packages topic for details.

Add Import Namespaces

After the packages are installed, open the ~/_Imports.razor file and import the Syncfusion.Blazor and Syncfusion.Blazor.Navigations namespaces.

~/_Imports.razor

@using Syncfusion.Blazor
@using Syncfusion.Blazor.Navigations

Register Syncfusion^® Blazor service

Register the Syncfusion^® Blazor service in the Program.cs file of your Blazor WebAssembly App.

Program.cs

....
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 and script references in the ~/index.html file.

<link href="_content/Syncfusion.Blazor.Themes/fluent2.css" rel="stylesheet" />
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>

NOTE

Check out the Blazor Themes topic to discover various methods (Static Web Assets, CDN, and CRG) for referencing themes in the Blazor application. Also, check out the Adding Script Reference topic to learn different approaches for adding script references in the Blazor application.

Add Syncfusion^® Blazor Breadcrumb component

Add the Syncfusion^® Blazor Breadcrumb component in the ~/Pages/Index.razor file.

Index.razor

<SfBreadcrumb></SfBreadcrumb>

• Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This renders the Syncfusion^® Blazor Breadcrumb component in the default web browser.

NOTE

The Breadcrumb component will render based on the current URL, when the Breadcrumb items are not specified.

Add items to the Blazor Breadcrumb component

To render Breadcrumb component with items use BreadcrumbItem tag directive as like below code example.

Index.razor

@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.

NOTE

View Sample in GitHub

See also

• Getting Started with Syncfusion^® Blazor for client side in .NET Core CLI
• Getting Started with Syncfusion^® Blazor for server side in Visual Studio
• Getting Started with Syncfusion^® Blazor for server side in .NET Core CLI

NOTE

You can also explore our Blazor Breadcrumb example that shows you how to render and configure the breadcrumb.