Getting Started with Blazor QueryBuilder Component

9 Nov 20214 minutes to read

This section briefly explains about how to include Query Builder Component in your Blazor server-side application. You can refer Getting Started with Syncfusion Blazor for Server-side in Visual Studio page for the introduction and configuring the common specifications.

To get start quickly with Query Builder Component using Blazor, you can check on this video:

You can also explore our Blazor Query Builder example to knows how to render and configure the query builder.

Importing Syncfusion Blazor component in the application

  1. Install the Syncfusion.Blazor NuGet package to the application by using the NuGet Package Manager.

  2. You can add the client-side style resources through CDN or from NuGet package in the <head> element of the ~/Pages/_Host.cshtml page.

    Please ensure to check the Include prerelease option.

     <head>
         <link href="_content/Syncfusion.Blazor/styles/material.css" rel="stylesheet" />
         <!---CDN--->
         @*<link href="https://cdn.syncfusion.com/blazor/19.3.43/material.css" rel="stylesheet" />*@
     </head>

    For Internet Explorer 11 kindly refer the polyfills. Refer the documentation for more information.

     <head>
         <environment include="Development">
             <link href="_content/Syncfusion.Blazor/styles/material.css" rel="stylesheet" />
             <script src="https://github.com/Daddoon/Blazor.Polyfill/releases/download/3.0.1/blazor.polyfill.min.js"></script>
         </environment>
     </head>

Adding component package to the application

Open /_Imports.razor file and import the Syncfusion.Blazor.QueryBuilder package.

@using Syncfusion.Blazor.QueryBuilder

Add SyncfusionBlazor service in Startup.cs

Open the Startup.cs file and add services required by Syncfusion components. Add services.AddSyncfusionBlazor() method in the ConfigureServices function as follows.

namespace BlazorApplication
{
    public class Startup
    {
        ....
        ....
        public void ConfigureServices(IServiceCollection services)
        {
            ....
            ....
            services.AddSyncfusionBlazor();
        }
    }
}

To enable custom client side resource loading from CRG or CDN. You need to disable resource loading by AddSyncfusionBlazor(true) and load the scripts in the HEAD element of the ~/Pages/_Host.cshtml page.

<head>
    <script src="https://cdn.syncfusion.com/blazor/19.3.43/syncfusion-blazor.min.js">
    </script>
</head>

Adding Query Builder component to the application

Now, add the Blazor Query Builder component in razor page in the Pages folder. For example, the Query Builder component is added in the ~/Pages/Index.razor page.

@using Syncfusion.Blazor.QueryBuilder

<SfQueryBuilder TValue="EmployeeDetails">
    <QueryBuilderColumns>
        <QueryBuilderColumn Field="EmployeeID" Label="Employee ID" Type="ColumnType.Number"></QueryBuilderColumn>
        <QueryBuilderColumn Field="FirstName" Label="First Name" Type="ColumnType.String"></QueryBuilderColumn>
        <QueryBuilderColumn Field="TitleOfCourtesy" Label="Title of Courtesy" Type="ColumnType.Boolean" Values="Values"></QueryBuilderColumn>
        <QueryBuilderColumn Field="Title" Label="Title" Type="ColumnType.String"></QueryBuilderColumn>
        <QueryBuilderColumn Field="HireDate" Label="Hire Date" Type="ColumnType.Date"></QueryBuilderColumn>
        <QueryBuilderColumn Field="Country" Label="Country" Type="ColumnType.String"></QueryBuilderColumn>
        <QueryBuilderColumn Field="City" Label="City" Type="ColumnType.String"></QueryBuilderColumn>
    </QueryBuilderColumns>
</SfQueryBuilder>

@code {
    private string[] Values = new string[] { "Mr.", "Mrs." };
    public class EmployeeDetails
    {
        public int EmployeeID { get; set; }
        public string FirstName { get; set; }
        public bool TitleOfCourtesy { get; set; }
        public string Title { get; set; }
        public DateTime HireDate { get; set; }
        public string Country { get; set; }
        public string City { get; set; }
    }
}

Run the application

After successful compilation of your application, simply press F5 to run the application. The Blazor Query Builder component will render in the web browser as shown below

Blazor QueryBuilder Component

See Also