Getting Started with Blazor QueryBuilder Component

4 Nov 20256 minutes to read

This section explains how to add the Blazor Query Builder component to a Blazor WebAssembly app using Visual Studio or Visual Studio Code.

To get started quickly with Blazor Query Builder, check out the following video or the GitHub sample:

NOTE

Explore the Blazor Query Builder example to learn how to render and configure the Query Builder.

Prerequisites

Create a new Blazor App in Visual Studio

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

Install Syncfusion® Blazor QueryBuilder and Themes NuGet in the App

To add the Blazor Query Builder component, open the NuGet Package Manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), then search for and install Syncfusion.Blazor.QueryBuilder and Syncfusion.Blazor.Themes. Alternatively, use the following Package Manager commands:

Install-Package Syncfusion.Blazor.QueryBuilder -Version 31.2.12 Install-Package Syncfusion.Blazor.Themes -Version 31.2.12

NOTE

Syncfusion® Blazor components are available on nuget.org. See NuGet packages for the full package list and component details.

Prerequisites

Create a new Blazor App in Visual Studio Code

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

Alternatively, create a WebAssembly application using the following command in the terminal (Ctrl+`).

dotnet new blazorwasm -o BlazorApp cd BlazorApp

Install Syncfusion® Blazor QueryBuilder and Themes NuGet in the App

  • Press Ctrl+` to open the integrated terminal in Visual Studio Code.
  • Ensure you are in the project root directory where the .csproj file is located.
  • Run the following commands to install Syncfusion.Blazor.QueryBuilder and Syncfusion.Blazor.Themes, and restore packages.
dotnet add package Syncfusion.Blazor.QueryBuilder -v 31.2.12 dotnet add package Syncfusion.Blazor.Themes -v 31.2.12 dotnet restore

NOTE

Syncfusion® Blazor components are available on nuget.org. See NuGet packages for the full package list and component details.

Register Syncfusion® Blazor Service

Open ~/_Imports.razor and import the Syncfusion.Blazor and Syncfusion.Blazor.QueryBuilder namespaces.

@using Syncfusion.Blazor @using Syncfusion.Blazor.QueryBuilder

Now register the Syncfusion® Blazor service in ~/Program.cs for your Blazor WebAssembly app.

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(sp => 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 are provided via NuGet as Static Web Assets. Include the stylesheet and script references in the <head> of ~/index.html.

<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

See 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 QueryBuilder component

Add the Syncfusion® Blazor Query Builder component in ~/Pages/Index.razor.

<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; } } }
  • Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This renders the Syncfusion® Blazor Query Builder component in the default web browser.

Blazor Query Builder component

See also