Create Custom Grid Component in Blazor DataGrid Component

21 Feb 20224 minutes to read

You can create a custom Grid component by rendering the SfGrid as a new razor component. It helps to create your own custom component when you want to create multiple grids with same configuration or with default configuration throughout your application.

This is demonstrated in the following example by creating a custom Grid component called CustomGrid, where SfGrid is rendered with some basic default properties such as GridPageSettings etc., which will be reflected in all the Grids rendered using the CustomGrid component.


@using Syncfusion.Blazor.Grids
@typeparam TValue
@inherits SfGrid<TValue>

<SfGrid TValue="TValue" AllowSorting="AllowSorting" AllowPaging="AllowPaging" @attributes="props">
    <GridPageSettings PageCount="PAGE_COUNT" PageSize="DEFAULT_PAGE_SIZE" PageSizes="PageSizes"></GridPageSettings>


using Microsoft.AspNetCore.Components;
using Syncfusion.Blazor.Grids;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace SF_Grid_Inheritance.Shared
    public partial class CustomGrid<TValue> : SfGrid<TValue>
        public const int PAGE_COUNT = 5;
        public const int DEFAULT_PAGE_SIZE = 10;
        public string[] PageSizes = new string[] { "10", "20", "50" };
        IReadOnlyDictionary<string, object> props { get; set; }
        public override Task SetParametersAsync(ParameterView parameters)
            //Assign the additional parameters
            props = parameters.ToDictionary();
            return base.SetParametersAsync(parameters);
        protected async override Task OnParametersSetAsync()
            AllowPaging = true;
            AllowSorting = true;
            await base.OnParametersSetAsync();


<CustomGrid DataSource="Orders" TValue="Order"></CustomGrid>

    public List<Order> Orders { get; set; }
    protected override void OnInitialized()
        Orders = Enumerable.Range(1, 75).Select(x => new Order()
            OrderID = 1000 + x,
            CustomerID = (new string[] { "ALFKI", "ANANTR", "ANTON", "BLONP", "BOLID" })[new Random().Next(5)],
            Freight = 2.1 * x,
            OrderDate = DateTime.Now.AddDays(-x),
    public class Order
        public int? OrderID { get; set; }
        public string CustomerID { get; set; }
        public DateTime? OrderDate { get; set; }
        public double? Freight { get; set; }