Getting Started with Blazor DataGrid in Blazor WASM App

31 Aug 20268 minutes to read

This section briefly explains how to include the Blazor DataGrid in a Blazor WebAssembly App using Visual Studio, Visual Studio Code, and the .NET CLI.

Ready to streamline your Blazor development?
Discover the full potential of Blazor components with AI Coding Assistants. Effortlessly integrate, configure, and enhance your projects with intelligent, context-aware code suggestions, streamlined setups, and real-time insights—all seamlessly integrated into your preferred AI-powered IDEs like VS Code, Cursor, Code Studio and more. Explore AI Coding Assistants

Using .NET CLI Templates

Quickly set up a Blazor application using the preconfigured Syncfusion WebAssembly App Template.

First, install the template using the .NET CLI.

dotnet new install Syncfusion.Blazor.WebAssemblyApp.Templates

Next, create a new project with following command.

dotnet new syncfusionblazorwasmapp --name MyApp --pwa true

After creating the project, navigate to the main project folder (for example, MyApp) and run the following command.

  • .NET CLI
    • cd MyApp
dotnet run

    Manually creating a new Blazor WebAssembly (Standalone) App

    Create a Blazor WebAssembly App using Visual Studio via Microsoft Templates or the Syncfusion® Blazor Extension.

    Run the following command to create a new Blazor WebAssembly App.

    dotnet new blazorwasm -o BlazorApp
cd BlazorApp

    Alternatively, create a Blazor WebAssembly App using Visual Studio Code via Microsoft Templates or the Syncfusion® Blazor Extension, or the C# Dev Kit extension.

    Install the required Blazor packages

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

    1. Go to Tools → NuGet Package Manager → Manage NuGet Packages for Solution.
    2. Search the required NuGet packages (Syncfusion.Blazor.Grid and Syncfusion.Blazor.Themes) and install them.

    Alternatively, you can install the same packages using the Package Manager Console with the following commands.

    Install-Package Syncfusion.Blazor.Grid -Version 34.2.2
Install-Package Syncfusion.Blazor.Themes -Version 34.2.2

    Open the terminal and run the following commands.

    dotnet add package Syncfusion.Blazor.Grid -v 34.2.2
dotnet add package Syncfusion.Blazor.Themes -v 34.2.2

    Add import namespaces

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

    @using Syncfusion.Blazor
@using Syncfusion.Blazor.Grids

    Register the Blazor service

    Open the Program.cs file in Blazor WebAssembly App and register the Blazor service and include the required namespace reference using Syncfusion.Blazor; at the top.

    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 at the end of the <head> section in the ~wwwroot/index.html file.

    <link href="_content/Syncfusion.Blazor.Themes/fluent2.css" rel="stylesheet" />

    Include the required script references at the end of the <body> section in the ~wwwroot/index.html file to enable DataGrid functionality.

    <script src="_content/Syncfusion.Blazor.Grid/scripts/sf-grid.min.js" type="text/javascript"></script>

    Add Blazor DataGrid component

    Open a Razor file located in the ~/Pages/Home.razor and add the Blazor DataGrid component inside the razor file.

    @using Syncfusion.Blazor.Grids

<SfGrid DataSource="@OrderData">
    <GridColumns>
        <GridColumn Field=@nameof(OrderDetails.OrderID) HeaderText="Order ID" TextAlign="TextAlign.Right" Width="120"></GridColumn>
        <GridColumn Field=@nameof(OrderDetails.CustomerID) HeaderText="Customer Name" Width="120"></GridColumn>
        <GridColumn Field=@nameof(OrderDetails.Freight) HeaderText="Freight" Format="C2" TextAlign="TextAlign.Right" EditType="EditType.NumericEdit" Width="120"></GridColumn>
        <GridColumn Field=@nameof(OrderDetails.ShipCountry) HeaderText="Ship Country" EditType="EditType.DropDownEdit" Width="150"></GridColumn>
    </GridColumns>
</SfGrid>

@code 
{
    public List<OrderDetails> OrderData { get; set; }
    protected override void OnInitialized()
    {
        OrderData = OrderDetails.GetAllRecords();
    }
}
    public class OrderDetails
{
    public static List<OrderDetails> Order = new List<OrderDetails>();
    public OrderDetails(int OrderID, string CustomerId, double Freight, string ShipCountry)
    {
        this.OrderID = OrderID;
        this.CustomerID = CustomerId;
        this.Freight = Freight;
        this.ShipCountry = ShipCountry;    
    }
    public static List<OrderDetails> GetAllRecords()
    {
        if (Order.Count == 0)
        {
            Order.Add(new OrderDetails(10248, "VINET", 32.38, "France"));
            Order.Add(new OrderDetails(10249, "TOMSP", 11.61, "Germany"));
            Order.Add(new OrderDetails(10250, "HANAR", 65.83, "Brazil"));
            Order.Add(new OrderDetails(10251, "VICTE", 41.34, "France"));
            Order.Add(new OrderDetails(10252, "SUPRD", 51.3, "Belgium"));
        }
        return Order;
    }
    public int OrderID { get; set; }
    public string CustomerID { get; set; }
    public double Freight { get; set; }
    public string ShipCountry { get; set; }
}

    Run the application

    Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. The Blazor DataGrid component will render in your default web browser.

    Open the terminal and run the following command.

    dotnet run