Getting Started with Blazor Chip Component
31 Jan 20245 minutes to read
This section briefly explains about how to include Blazor Chip component in your Blazor Server App and Blazor WebAssembly App using Visual Studio.
Prerequisites
Create a new Blazor App in Visual Studio
You can create a Blazor Server App or Blazor WebAssembly App using Visual Studio via Microsoft Templates or the Syncfusion Blazor Extension.
Install Syncfusion Blazor Buttons and Themes NuGet in the App
To add Blazor Chip 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.Buttons and Syncfusion.Blazor.Themes. Alternatively, you can utilize the following package manager command to achieve the same.
Install-Package Syncfusion.Blazor.Buttons -Version 27.1.48
Install-Package Syncfusion.Blazor.Themes -Version 27.1.48
NOTE
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.Buttons
namespace.
@using Syncfusion.Blazor
@using Syncfusion.Blazor.Buttons
Now, register the Syncfusion Blazor Service in the ~/Program.cs file of your Blazor Server App or Blazor WebAssembly App.
using Microsoft.AspNetCore.Components;
using Microsoft.AspNetCore.Components.Web;
using Syncfusion.Blazor;
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddServerSideBlazor();
builder.Services.AddSyncfusionBlazor();
var app = builder.Build();
....
using Microsoft.AspNetCore.Components.Web;
using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
using Syncfusion.Blazor;
var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.RootComponents.Add<App>("#app");
builder.RootComponents.Add<HeadOutlet>("head::after");
builder.Services.AddScoped(serviceProvider => new HttpClient { BaseAddress = new Uri(builder.HostEnvironment.BaseAddress) });
builder.Services.AddSyncfusionBlazor();
await builder.Build().RunAsync();
....
Add stylesheet and script resources
The theme stylesheet and script can be accessed from NuGet through Static Web Assets. Reference the stylesheet and script in the <head>
of the main page as follows:
-
For .NET 6 Blazor Server app, include it in ~/Pages/_Layout.cshtml file.
-
For .NET 7 Blazor Server app, include it in the ~/Pages/_Host.cshtml file.
-
For Blazor WebAssembly app, include it in the ~/index.html file.
<head>
....
<link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>
</head>
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 Blazor Chip component
Add the Syncfusion Blazor Chip component in the ~/Pages/Index.razor file.
<SfChip>
<ChipItems>
<ChipItem Text="Janet Leverling"></ChipItem>
</ChipItems>
</SfChip>
- Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This will render the Syncfusion Blazor Chip component in your default web browser.
Render chip items from collection
You can render the chip items from collection using for loop in Blazor Chip component as follows.
@using Syncfusion.Blazor.Buttons
@if(ChipData.Count != 0) {
<SfChip EnableDelete="true">
<ChipItems>
@foreach (ChipCollection currentData in ChipData)
{
<ChipItem Text=@currentData.text Enabled=@currentData.enabled></ChipItem>
}
</ChipItems>
</SfChip>
}
@code{
public List<ChipCollection> ChipData = new List<ChipCollection>();
public class ChipCollection
{
public string text { get; set; }
public bool enabled { get; set; }
}
protected override async Task OnInitializedAsync()
{
await base.OnInitializedAsync();
await Task.Delay(2000);
ChipData.Add(new ChipCollection
{
text = "Jenifer",
enabled = true
});
ChipData.Add(new ChipCollection
{
text = "Amenda",
enabled = true
});
ChipData.Add(new ChipCollection
{
text = "Isabella",
enabled = true
});
ChipData.Add(new ChipCollection
{
text = "James",
enabled = true
});
}
}