This article provides a step-by-step introduction to configure Essential JS 2 for Blazor setup, build and run a simple Blazor client-side web application using .Net Core CLI.
Step 1: Install the Blazor project templates by using below command line in the command prompt:
dotnet new -i Microsoft.AspNetCore.Blazor.Templates::3.0.0-preview6.19307.2
Step 2: Once project templates installed, run the following command line to create a new Blazor client-side application.
dotnet new blazor -o WebApplication1
cd WebApplication1
Step 1: Now, add Syncfusion.Blazor NuGet package to the new application using below command line.
dotnet add package Syncfusion.Blazor
dotnet restore
Step 2: The Syncfusion Blazor package will be included in the newly created project after the installation process is completed
Step 3: Open ~/_Imports.razor file and import the Syncfusion.Blazor
.
@using Syncfusion.Blazor
@using Syncfusion.Blazor.Grids
Add the client-side resource through CDN or local npm package in the <head>
element of the ~/Pages/index.html page.
<head>
....
....
<link href="https://cdn.syncfusion.com/blazor/styles/fabric.css" rel="stylesheet" />
</head>
To initialize the DataGrid component add the below code to your Index.razor view page which is present under ~/Pages folder. For example, the DataGrid component is added in the ~/Pages/Index.razor page.
<SfGrid >
</SfGrid>
To bind data for the DataGrid component, you can assign a IEnumerable object to the DataSource
property. The list data source can also be provided as an instance of the DataManager
. You can assign the data source through the OnInitialized lifecycle of the page.
<SfGrid DataSource="@gridData">
</SfGrid>
@code{
public List<OrdersDetails> gridData { get; set; }
protected override void OnInitialized()
{
gridData = OrdersDetails.GetAllRecords();
}
}
The columns are automatically generated when columns declaration is empty or undefined while initializing the datagrid.
The DataGrid has an option to define columns using GridColumns
component. In GridColumn
component we have properties to customize columns.
Let’s check the properties used here:
Field
to map with a property name an array of JavaScript objects.HeaderText
to change the title of columns.TextAlign
to change the alignment of columns. By default, columns will be left aligned. To change columns to right align, we need to define TextAlign
as Right
.Format
. Using this, we can format number and date values to standard or custom formats.<SfGrid DataSource="@gridData">
<GridColumns>
<GridColumn Field=@nameof(OrdersDetails.OrderID) HeaderText="Order ID" TextAlign="TextAlign.Right" Width="120"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.CustomerID) HeaderText="Customer Name" Width="150"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.OrderDate) HeaderText=" Order Date" Format="d" Type="ColumnType.Date" TextAlign="TextAlign.Right" Width="130"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.Freight) HeaderText="Freight" Format="C2" TextAlign="TextAlign.Right" Width="120"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.ShipCountry) HeaderText="Ship Country" Width="150"></GridColumn>
</GridColumns>
</SfGrid>
@code{
public List<OrdersDetails> gridData { get; set; }
protected override void OnInitialized()
{
gridData = OrdersDetails.GetAllRecords();
}
}
The paging feature enables users to view the datagrid record in a paged view. It can be enabled by setting the AllowPaging
property to true. Pager can be customized using the GridPageSettings
component.
<SfGrid DataSource="@gridData" AllowPaging="true">
<GridPageSettings PageSize="5"></GridPageSettings>
<GridColumns>
<GridColumn Field=@nameof(OrdersDetails.OrderID) HeaderText="Order ID" TextAlign="TextAlign.Right" Width="120"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.CustomerID) HeaderText="Customer Name" Width="150"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.OrderDate) HeaderText=" Order Date" Format="d" Type="ColumnType.Date" TextAlign="TextAlign.Right" Width="130"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.Freight) HeaderText="Freight" Format="C2" TextAlign="TextAlign.Right" Width="120"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.ShipCountry) HeaderText="Ship Country" Width="150"></GridColumn>
</GridColumns>
</SfGrid>
@code{
public List<OrdersDetails> gridData { get; set; }
protected override void OnInitialized()
{
gridData = OrdersDetails.GetAllRecords();
}
}
The sorting feature enables you to order the records. It can be enabled by setting the AllowSorting
property as true. Sorting feature can be customized using the GridSortSettings
component.
<SfGrid DataSource="@gridData" AllowPaging="true" AllowSorting="true">
<GridPageSettings PageSize="5"></GridPageSettings>
<GridColumns>
<GridColumn Field=@nameof(OrdersDetails.OrderID) HeaderText="Order ID" TextAlign="TextAlign.Right" Width="120"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.CustomerID) HeaderText="Customer Name" Width="150"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.OrderDate) HeaderText=" Order Date" Format="d" Type="ColumnType.Date" TextAlign="TextAlign.Right" Width="130"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.Freight) HeaderText="Freight" Format="C2" TextAlign="TextAlign.Right" Width="120"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.ShipCountry) HeaderText="Ship Country" Width="150"></GridColumn>
</GridColumns>
</SfGrid>
@code{
public List<OrdersDetails> gridData { get; set; }
protected override void OnInitialized()
{
gridData = OrdersDetails.GetAllRecords();
}
}
The filtering feature enables you to view reduced amount of records based on filter criteria. It can be enabled by setting the AllowFiltering
property as true. Filtering feature can be customized using the FilterSettings
property.
<SfGrid DataSource="@gridData" AllowPaging="true" AllowSorting="true" AllowFiltering="true">
<GridPageSettings PageSize="5"></GridPageSettings>
<GridColumns>
<GridColumn Field=@nameof(OrdersDetails.OrderID) HeaderText="Order ID" TextAlign="TextAlign.Right" Width="120"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.CustomerID) HeaderText="Customer Name" Width="150"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.OrderDate) HeaderText=" Order Date" Format="d" Type="ColumnType.Date" TextAlign="TextAlign.Right" Width="130"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.Freight) HeaderText="Freight" Format="C2" TextAlign="TextAlign.Right" Width="120"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.ShipCountry) HeaderText="Ship Country" Width="150"></GridColumn>
</GridColumns>
</SfGrid>
@code{
public List<OrdersDetails> gridData { get; set; }
protected override void OnInitialized()
{
gridData = OrdersDetails.GetAllRecords();
}
}
The grouping feature enables you to view the datagrid record in a grouped view. It can be enabled by setting the AllowGrouping
property as true. Grouping feature can be customized using the GridGroupSettings
component.
<SfGrid DataSource="@gridData" AllowPaging="true" AllowSorting="true" AllowFiltering="true" AllowGrouping="true">
<GridPageSettings PageSize="5"></GridPageSettings>
<GridColumns>
<GridColumn Field=@nameof(OrdersDetails.OrderID) HeaderText="Order ID" TextAlign="TextAlign.Right" Width="120"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.CustomerID) HeaderText="Customer Name" Width="150"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.OrderDate) HeaderText=" Order Date" Format="d" Type="ColumnType.Date" TextAlign="TextAlign.Right" Width="130"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.Freight) HeaderText="Freight" Format="C2" TextAlign="TextAlign.Right" Width="120"></GridColumn>
<GridColumn Field=@nameof(OrdersDetails.ShipCountry) HeaderText="Ship Country" Width="150"></GridColumn>
</GridColumns>
</SfGrid>
@code{
public List<OrdersDetails> gridData { get; set; }
protected override void OnInitialized()
{
gridData = OrdersDetails.GetAllRecords();
}
}
Output be like the below.