Skip to main content

Blazor WebAssembly Dynamic Form Validation


Introduction:

In Blazor WebAssembly(client-side framework) form validation can be done with Data Annotations.
Using Data Annotations we can validate form either by default validation attributes or by creating custom validation attributes. Using this Data Annotation attribute we can dynamically add or remove validation on a specific field in a form.

Create Blazor WebAssembly Project:

To create a Blazor WebAssembly template project need to install the latest version of VisualStudio 2019 for rich intelligence support or we can use VisualStudio code but less intelligence support from the editor. Click here to know about Blazor WebAssembly template creation.
Blazor WebAssembly is in preview mode, not yet ready for production.

Create Razor Component:

After creating a sample project using the Blazor WebAssembly template, in "Pages" folder add new Razor Component, name it as "UserForm.razor"

Add Route:

In Blazor routing can be configured using @page  directive, and URL should be enclosed in double-quotes and prefixed with "/". In "UserForm.razor" file add routing as below

 @page "/userform"

Create Form Model:

Now we need to create a model that holds data to form or data from a form. Add a folder name it as "Models". Create a class into the "Models" folder and name it as "UserFormModel".cs

   public class UserFormModel
    {
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public string ContactType { get; set; }
        public string Email { get; set; }
        public string Phone { get; set; }
    }

EditForm Razor Component:

"EditForm" Razor component is the default razor component provided by Blazor WebAssembly. It helps to create form and its validations. EditFrom creates an EditContext, that tracks fields modified in the form and tracks validation messages. EditForm built up with default events like OnValidSubmit, OnInvalidSubmit, OnSubmit, etc.

<EditForm OnValidSubmit="@submit">
</EditForm>

DataAnnotationsValidator Razor Component:

DataAnnotationsValidator Razor Component attaches validation support using Data Annotations.

  <DataAnnotationsValidator />

ValidationSummary Razor Component:

ValidationSummary Razor Component summarizes validation messages

  <ValidationSummary />

ValidationMessage Razor Component:

ValidationMessage Razor Component, displays validation message specific field in the form.

  <ValidationMessage For="@(() => model.propertyName)" />

Default Form Field Razor Component:

To apply validation logic to form fields Blazor has implemented default Razor Components:
1. "InputText" component for Html Input filed
2. "InputTextArea" component for Html Textarea field
3. "InputSelect" component for Html Select field

Design UserForm:

Update the "UserForm.razor" as follows

 
@page "/userform"
@using Model
<h3>UserForm</h3>

<EditForm Model="@user" OnValidSubmit="@Submit">
    <DataAnnotationsValidator></DataAnnotationsValidator>
    
    <div class="form-group row">
        <label for="txtFirstName" class="col-sm-2 col-form-label">First Name</label>
        <div class="col-sm-10">
            <InputText id="txtFirstName" class="form-control" @bind-Value="@user.FirstName"></InputText>
            <ValidationMessage For="@(() => user.FirstName)"></ValidationMessage>
        </div>
    </div>
    <div class="form-group row">
        <label for="txtLastName" class="col-sm-2 col-form-label">Last Name</label>
        <div class="col-sm-10">
            <InputText id="txtLastName" class="form-control" @bind-Value="@user.LastName"></InputText>
            <ValidationMessage For="@(() => user.LastName)"></ValidationMessage>
        </div>
    </div>
    <div class="form-group row">
        <label for="txtContactType" class="col-sm-2 col-form-label">Contact Type</label>
        <div class="col-sm-10">
            <InputSelect id="txtContactType" class="form-control" @bind-Value="@user.ContactType">
                <option selected value="-1">-Select-</option>
                <option value="email">Email</option>
                <option value="phone">Phone</option>
            </InputSelect>
            <ValidationMessage For="@(() => user.ContactType)"></ValidationMessage>
        </div>
    </div>
    <div class="form-group row">
        <label for="txtEmail" class="col-sm-2 col-form-label">Email</label>
        <div class="col-sm-10">
            <InputText id="txtEmail" class="form-control" @bind-Value="@user.Email"></InputText>
            <ValidationMessage For="@(() => user.Email)"></ValidationMessage>
        </div>
    </div>
    <div class="form-group row">
        <label for="txtPhone" class="col-sm-2 col-form-label">Phone</label>
        <div class="col-sm-10">
            <InputText id="txtPhone" class="form-control" @bind-Value="@user.Phone"></InputText>
            <ValidationMessage For="@(() => user.Phone)"></ValidationMessage>
        </div>
    </div>
    <div class="form-group">
        <button type="submit" class="btn btn-primary">Save</button>
    </div>
</EditForm>

@code {
    UserFormModel user;

    protected override void OnInitialized()
    {
        user = new UserFormModel();
    }

    public void Submit()
    {
        // this method calls on valid form
        // save form data by posting data to your api
    }
}

. Create a UserFormModel variable as a user which will be used for form model binding.
. OnInitialized is Blazor life-cycle method, where we can initiate a code before rendering Html.
. Submit will be triggered from the submit button if the form is valid.
. Model property on the EditForm component to bind the model to the form.
. OnValidSubmit event of EditForm component gets triggered on submit click if the form is valid.
. DataAnnotationsValidator component to activate Data Annotation validation functionality  to the form

Now run the application and navigate to "http://localhost:57213/userform"

Required Field Validation:

Now make "First Name" and "Last Name" as mandatory fields in the form. For that, we can apply the Data Annotations attribute [Required] to make those fields mandatory. Update code in "UserFormModel.cs" as below

  using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Threading.Tasks;

namespace FormValidation.Model
{
    public class UserFormModel
    {
        [Required]
        public string FirstName { get; set; }
        [Required]
        public string LastName { get; set; }
        public string ContactType { get; set; }
        public string Email { get; set; }
        public string Phone { get; set; }
    }
}

Now navigate to the application "http://localhost:57213/userform", click on submit button

Dynamic Custom Validation:

ContactType is "Email", then we need to validate the email field, no need to validate the phone field.
. ContactType is "Phone", then we need to validate the phone field, no need to validate the email field.
. ContacType is "-Select-" then no validation phone and email fields

Now add a new folder name as "Validations" and add a file name it as "DynamicContactValidationAttribute.cs"

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Text.RegularExpressions;
using System.Threading.Tasks;

namespace FormValidation.Validations
{
    public class DynamicContactValidationAttribute:ValidationAttribute
    {
        private readonly string _parentFieldName;
        private readonly string _fieldType;
        private readonly string[] _validationTypes;

        public DynamicContactValidationAttribute(
            string ParentFieldName,
            string FieldType,
            string[] ValidationTypes)
        {
            _parentFieldName = ParentFieldName;
            _fieldType = FieldType;
            _validationTypes = ValidationTypes;
        }

        protected override ValidationResult IsValid(object value, ValidationContext validationContext)
        {
            if(validationContext.ObjectInstance != null)
            {
                var parentFieldValueObject = validationContext.ObjectInstance.GetType()
                    .GetProperty(_parentFieldName).GetValue(validationContext.ObjectInstance, null);
                string parentFieldValue = parentFieldValueObject != null ? parentFieldValueObject as string : string.Empty;

                string currentFieldValue = value != null ? value as string : string.Empty;

                if (!string.IsNullOrEmpty(parentFieldValue) && parentFieldValue.ToLower() == _fieldType.ToLower())
                {
                    if (string.IsNullOrEmpty(currentFieldValue) &&
                        _validationTypes.Any(_ => _.ToLower() == "required"))
                    {
                        return new ValidationResult($"{validationContext.DisplayName} is requied", new[] { validationContext.MemberName });
                    }
                    else if (_validationTypes.Any(_ => _.ToLower() == "email"))
                    {
                        bool isEmail = Regex.IsMatch(currentFieldValue, @"\A(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)\Z", RegexOptions.IgnoreCase);
                        if (!isEmail)
                        {
                            return new ValidationResult($"{validationContext.DisplayName} is not a valid email", new[] { validationContext.MemberName });
                        }
                    }
                    else if(_validationTypes.Any(_ => _.ToLower() == "phone"))
                    {
                        bool isPhone = Regex.IsMatch(currentFieldValue, @"\+?[0-9]{10}");
                        if (!isPhone)
                        {
                            return new ValidationResult($"{validationContext.DisplayName} is not a valid phone", new[] { validationContext.MemberName });
                        }
                    }
                }
            }
            return ValidationResult.Success;
        }
    }
}

. "ValidationAttribute" inherit to override "IsValid(object value, ValidationContext validationContext)"
. To this custom validator pass parameters like "ParentFieldName(ContactType field)","FieldType(current filed where this custom validation attribute configured either email field or phone field)","ValidationTypes(like extra validation like email,phone, etc)"
. "ValidationContext" provide all the information about current property and model of current propety, it tracks the validation errors and also tracks property value changes.
. "ValidationResult" takes error mesage and field name to which that error message refer to as input parameters.

Update Model To Use Custom Validation:

update the code in file "UserFormModel.cs" as below

 public class UserFormModel
    {
        [Required]
        public string FirstName { get; set; }
        [Required]
        public string LastName { get; set; }
        public string ContactType { get; set; }
        [DynamicContactValidation(ParentFieldName: "ContactType",FieldType:"Email",ValidationTypes:new[] { "required","email" })]
        public string Email { get; set; }
        [DynamicContactValidation(ParentFieldName: "ContactType", FieldType: "Phone", ValidationTypes: new[] { "required", "phone" })]
        public string Phone { get; set; }
    }
Now run application and change ContactType to "Email" and leave email field empty then error show email required
Now  select ContactType to "Email" and enter invalid email then the error shows as invalid email
Similarly test for ContactType as "Phone"

Refer:

Comments

  1. Hi, what is different between client side webassembly and javascript? Is both run in client side. Anything different?

    ReplyDelete
    Replies
    1. WebAssembly is to execute server-side programming language like c# in the browser sandbox. It is a similar way as javascript works with the browser.

      Delete

Post a Comment

Popular posts from this blog

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route.

An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below
app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaults:new { …

GraphQL API Integration In Asp.Net Core Application

Introduction:
GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data.
How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions.HTTP-POST is the only Http verb recommended by the GraphQL.The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API:The main building blocks of GraphQL API is Schemas and Types. A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc.Types likely to be called Grap…

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API.
When To Use Versioning:Any API response changes.Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production.Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types:Query String VersioningUrl Path VersioningMedia Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.
 Install-Package Microsoft.AspNetCore.Mvc.Versioning -version 4.0.0 Register API V…

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload:The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client. Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file. Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk. If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application.
Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.  Check the link to use the Visual Studio Code for .NET Core Application.
IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files from the client, then the entire …

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items.
The main building block of ion-picker as follows: PickerControllerPickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options
PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker.
Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger", "Lion", "Elephant"…

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library jQuery Validate.
In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples.
Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio.
Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as below.
PersonController.cs: us…

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism:Blazor Server is a very light-weight web development framework. In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation. Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server. Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required information or changed …

NestJS API CRUD Operations With MongoDB

Introduction: NestJS is a framework used to develop server-side applications. NestJS built on top of Node.js frameworks like Express. It is a combination of Progressive Javascript, Object-Oriented Programming, Functional Programming, and Functional Reactive Programming.
Nest CLI Installation: Using Nest CLI we are able to generate the NestJS starter project with the default template. To install Nest CLI globally over our system open command prompt and run the command
npm i -g @nestjs/cli Now create a sample project by using Nest CLI command  nest new your_project_name package.json: Now open the package.json file from the sample application created, you can observe few properties like "scripts", "dependencies", and "devDependencies".
"dependencies" contains all plugins to be installed and used them to run the application.
"devDependencies" contain all plugins to be installed and used them at the time of application development.
"scrip…

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server.
Main Response Caching Headers are like below
Cache-ControlPragmaVary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response.private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores.max-age - this directive represents a time to hold a response in the cache.no-cache - this directive represents no storing of response and always fetch the fresh response from serverno-store…