Getting Started with Blazor DataForm Component

4 Nov 20255 minutes to read

This section explains how to add the Blazor DataForm component to a Blazor WebAssembly app using Visual Studio and Visual Studio Code.

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 DataForm and Themes NuGet in the App

To add the Blazor DataForm component to the app, open the NuGet Package Manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), then search for and install Syncfusion.Blazor.DataForm and Syncfusion.Blazor.Themes. Alternatively, you can utilize the following Package Manager commands to achieve the same.

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

NOTE

Syncfusion® Blazor components are available on NuGet. Refer to the NuGet packages topic for the available packages 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, you can create a WebAssembly application using the following command in the terminal (Ctrl+`).

dotnet new blazorwasm -o BlazorApp cd BlazorApp

Install Syncfusion® Blazor DataForm and Themes NuGet in the App

  • Press Ctrl+` to open the integrated terminal in Visual Studio Code.
  • Ensure you’re in the project root directory where your .csproj file is located.
  • Run the following commands to install the Syncfusion.Blazor.DataForm and Syncfusion.Blazor.Themes NuGet packages and ensure all dependencies are installed.
dotnet add package Syncfusion.Blazor.DataForm -v 31.2.12 dotnet add package Syncfusion.Blazor.Themes -v 31.2.12 dotnet restore

NOTE

Syncfusion® Blazor components are available on NuGet. Refer to the NuGet packages topic for the available packages and component details.

Register Syncfusion® Blazor Service

Open ~/_Imports.razor file and import the Syncfusion.Blazor and Syncfusion.Blazor.DataForm namespace.

@using Syncfusion.Blazor @using Syncfusion.Blazor.DataForm

Now, register the Syncfusion® Blazor Service in the ~/Program.cs file of 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 can be accessed from NuGet through Static Web Assets. Include the stylesheet and script references in the <head> section of the ~/index.html file.

<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

Check out the 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 DataForm component

Add the Syncfusion® Blazor DataForm component in the ~/Pages/Index.razor file.

@using System.ComponentModel.DataAnnotations <SfDataForm ID="MyForm" Model="@EmployeeDetail"> <FormValidator> <DataAnnotationsValidator></DataAnnotationsValidator> </FormValidator> <FormItems> <FormAutoGenerateItems></FormAutoGenerateItems> </FormItems> </SfDataForm> @code { public class EmployeeDetails { [Required(ErrorMessage = "Please enter your first name.")] [Display(Name = "First Name")] public string FirstName { get; set; } [Required(ErrorMessage = "Please enter your last name.")] [Display(Name = "Last Name")] public string LastName { get; set; } [Required(ErrorMessage = "Please enter your email address.")] [EmailAddress(ErrorMessage = "Please enter a valid email address.")] [Display(Name = "Email ID")] public string Email { get; set; } [Required] [Display(Name = "Date of Birth")] public DateTime? DOB { get; set; } } private EmployeeDetails EmployeeDetail = new EmployeeDetails() { FirstName = "Anne", LastName = "Lawsen" }; }
Blazor DataForm getting started example

NOTE

View Sample in GitHub.