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"

Support Me!
Buy Me A Coffee PayPal Me 

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

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'

.NET 7 Web API CRUD Using Entity Framework Core

In this article, we are going to implement a sample .NET 7 Web API CRUD using the Entity Framework Core. Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, and desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains programming functions that can be requested via HTTP calls either to fetch or update data for their respective clients. Some of the Key Characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build the REST full services. Install The SQL Server And SQL Management Studio: Let's install the SQL server on our l

ReactJS(v18) JWT Authentication Using HTTP Only Cookie

In this article, we will implement the ReactJS application authentication using the HTTP-only cookie. HTTP Only Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing the JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-ONly cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use the authentication with HTTP-only JWT cookie then we no need to implement the custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To authenticate our client application with JWT HTTP-only cookie, I developed a NetJS(which is a node) Mock API. Check the GitHub link and read the document on G

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Angular 14 State Management CRUD Example With NgRx(14)

In this article, we are going to implement the Angular(14) state management CRUD example with NgRx(14) NgRx Store For State Management: In an angular application to share consistent data between multiple components, we use NgRx state management. Using NgRx state helps to avoid unwanted API calls, easy to maintain consistent data, etc. The main building blocks for the NgRx store are: Actions - NgRx actions represents event to trigger the reducers to save the data into the stores. Reducer - Reducer's pure function, which is used to create a new state on data change. Store - The store is the model or entity that holds the data. Selector - Selector to fetch the slices of data from the store to angular components. Effects - Effects deals with external network calls like API. The effect gets executed based the action performed Ngrx State Management flow: The angular component needs data for binding.  So angular component calls an action that is responsible for invoking the API call.  Aft

Angular 14 Crud Example

In this article, we will implement CRUD operation in the Angular 14 application. Angular: Angular is a framework that can be used to build a single-page application. Angular applications are built with components that make our code simple and clean. Angular components compose of 3 files like TypeScript File(*.ts), Html File(*.html), CSS File(*.cs) Components typescript file and HTML file support 2-way binding which means data flow is bi-directional Component typescript file listens for all HTML events from the HTML file. Create Angular(14) Application: Let's create an Angular(14) application to begin our sample. Make sure to install the Angular CLI tool into our local machine because it provides easy CLI commands to play with the angular application. Command To Install Angular CLI npm install -g @angular/cli Run the below command to create the angular application. Command To Create Angular Application ng new name_of_your_app Note: While creating the app, you will see a noti

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

ReactJS(v18) Authentication With JWT AccessToken And Refresh Token

In this article, we are going to do ReactJS(v18) application authentication using the JWT Access Token and Refresh Token. JSON Web Token(JWT): JSON Web Token is a digitally signed and secured token for user validation. The JWT is constructed with 3 important parts: Header Payload Signature Create ReactJS Application: Let's create a ReactJS application to accomplish our demo. npx create-react-app name-of-your-app Configure React Bootstrap Library: Let's install the React Bootstrap library npm install react-bootstrap bootstrap Now add the bootstrap CSS reference in 'index.js'. src/index.js: import 'bootstrap/dist/css/bootstrap.min.css' Create A React Component 'Layout': Let's add a React component like 'Layout' in 'components/shared' folders(new folders). src/components/shared/Layout.js: import Navbar from "react-bootstrap/Navbar"; import { Container } from "react-bootstrap"; import Nav from "react-boot

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually