Skip to main content

Blazor Server CRUD Operation Using MudBlazor UI Components[.NET6]



In this article, we are going to implement CRUD operation in .NET6 Blazor Server application using the MudBlazor UI components.

Blazor Server:

Blazor Server is a single-page application. At the server, a pre-rendered HTML output of the page will be delivered to the user browsers. Any UI update, event handling, javascript calls will carry over by a SingnalR connection to the server. So application updates are depending on the continuous connection of the SignalR.

So Blazor server is a single-page application that can be made of C#. Since the blazor server only outputs the pre-rendered HTML to the client, so there is no c# code downloading into user browsers like in Blazor WebAssembly(c# code downloaded and run in the browser for blazor webassembly application).

SignalR Connection:

A Blazor Server application works over a SignalR connection. A Blazor Server application creates a UI State memory at the server which will be interacted by the SignalR connections. If a SignalR connection got interrupted, then the client tries to maintain the same state of the application by initiating a new SignalR connection and uses the existing UI state memory at the server. App routing changes, event changes, data changes everything will be carried out by the SignalR connection without any page reload.

Each browser screen or browser tab has its own SignalR Connection channels and UI states at the application. So each browser screen or browser tab acts as an individual user request.

Blazor Components:

Blazor Server application built on top of the 'Blazor Components'. A Blazor component file will be created like 'Example.razor', the file extension is '.razor'. A blazor component file consists of both c# and razor syntax. Blazor component also provides an option to split the file like 'Example.razor'(contains all razor code) and 'Example.razor.cs'(contains all c#code).

Create A .NET6 Blazor Server Application:

Let's create a .Net6 Blazor Server sample project 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.
CLI command
dotnet new blazorserver -o your_project_name

Let's understand a few key things about the project:
Route Middleware:- 
Program.cs:
  • The 'app.MapBlazorHub()' middleware is to enable the SignalR routing. The 'app.MapFallbackToPage()' middleware is to load the 'Pages/_Host.cshtml' so this is entry file gets loads.
Pages/_Host.cshtml:-
  • In Blazor Server '_Host.cshtml' is the entry file. We can observe here we configured the master layout that is '_Layout.cshtml'. Here 'App.razor' component is the entry component of the Blazor Sever.
App.razor:-
  • This is the blazor routing component. The 'RouteView' component to navigate to the respective Blazor Component.
wwwroot:-
The 'wwwroot' folder contains static  files like 'js', 'css', 'images',etc.

Install And Configure MudBlazor UI Library:

Run the below command to install the MudBlazor UI library.
Package Manager:
Install-Package MudBlazor -Version 6.0.2

.NET CLI Command:
dotnet add package MudBlazor --version 6.0.2

Now add the MudBlazor namespace like '@using MudBlazor' into the '_Imports.razor' file.

Now add the below CSS links into 'Pages/_Layout.csthml' inside of the 'Head' HTML tag.
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" rel="stylesheet" />
<link href="_content/MudBlazor/MudBlazor.min.css" rel="stylesheet" />
Now remove the existing CSS files inside of the 'Pages/_Layout.cshtml'.

Now add a Mudblazor js file into the 'Pages/cshtml' just above the closing body tag.
<script src="_content/MudBlazor/MudBlazor.min.js"></script>
In .NET6 'Startup.cs' file is excluded all service registration added to the 'Program.cs' file. Now let's register the MudBlazor service into the 'Program.cs' file.
Program.cs:
builder.Services.AddMudServices();
Now let's replace the content in 'Shared/MainLayout.razor' file.
Shared/MainLayout.razor:
@inherits LayoutComponentBase

<PageTitle>Dot6.BlazorServer.Crud.Learn</PageTitle>

<MudThemeProvider />
<MudDialogProvider />
<MudSnackbarProvider />

<MudLayout>
    <MudAppBar Color="Color.Primary">
        <MudText Typo="Typo.h4">Cakes Wold</MudText>
    </MudAppBar>
    <MudMainContent class="mt-4">
        @Body
    </MudMainContent>
</MudLayout>
  • (Line: 5) The 'MudThemeProvider' component was added as global registration. It helps apply styles or colors to our sample application.
  • (Line: 6) The 'MudDialogProvider' component was added as global registration. It is required to work with MudBlazor dialog.
  • (Line: 7) The 'MudSnackbarProvider' component was added as global registration. It is required to display notification messages.
  • (Line:  9&16) The 'MudLayout' component was added as a parent of all other components.
  • (Line: 10-12) The 'MudAppBar' component added display a nice header menu.
  • (Line: 13-14) The '@Body' a razor syntax that helps to render the Blazor page components and it was wrapped by the 'MudMainContent' component. The 'class="mt-4"'(margin-top) applying some margin between the 'MudAppBar' and 'MudMainContent' components.
Now let's run the application and check our app design.

SQL Sample Script:

Run the below script to create a table into the SQL server.

CREATE TABLE [dbo].[Cake] (
    [Id]          INT             IDENTITY (1, 1) NOT NULL,
    [Name]        VARCHAR (MAX)   NULL,
    [Price]       DECIMAL (18, 2) NULL,
    [Description] VARCHAR (MAX)   NULL
);

Install EntityFramework Core And Configure Database Context:

Install entity framework core library.
Package Manager:
Install-Package Microsoft.EntityFrameworkCore -Version 6.0.0

Package Manager:
dotnet add package Microsoft.EntityFrameworkCore --version 6.0.0

Install EFCore dependant SQL library.
Package Manager:
Install-Package Microsoft.EntityFrameworkCore.SqlServer -Version 6.0.0

Package Manager:
dotnet add package Microsoft.EntityFrameworkCore.SqlServer --version 6.0.0

Now let's create a table class like 'Cake.cs'.
Data/Entities/Cake.cs:
namespace Dot6.BlazorServer.Crud.Learn.Data.Entities;
public class Cake
{
    public int Id{get;set;}
    public string Name{get;set;}
    public decimal Price{get;set;}
    public string Description{get;set;} 
}
Now let's create the Database Context model like 'MyWorldDbContext.cs'
Data/Entities:
using Dot6.BlazorServer.Crud.Learn.Data.Entities;
using Microsoft.EntityFrameworkCore;

namespace Dot6.BlazorServer.Crud.Learn.Data;
public class MyWorldDbContext : DbContext
{
    public MyWorldDbContext(DbContextOptions<MyWorldDbContext> options) : base(options)
    {
        
    }
    public DbSet<Cake> Cake{get;set;}
}
Add the 'Cake.cs' and 'MyWorldDbContext.cs' namespace into the '_Import.razor'.
_Import.razor:
@using Dot6.BlazorServer.Crud.Learn.Data
@using Dot6.BlazorServer.Crud.Learn.Data.Entities
Add the database connection string into 'appsettings.Development.json' file.
appsettings.Development.json:
"ConnectionStrings":{
    "MyWorldDbConnection":"your_connection"
}
Register the DatabaseContext.
Program.cs:
builder.Services.AddDbContext<MyWorldDbContext>(options =>
{
    options.UseSqlServer(builder.Configuration.GetConnectionString("MyWorldDbConnection"));
});

Read Operation:

let's implement logic to read the records from the database and bind them to the UI. Let's update the Index.razor component as below
Index.razor:(Html Code)
@page "/"
@inject MyWorldDbContext _myworldDbContext;

<MudGrid Justify="Justify.Center" class="pr-4 pl-4">
    @foreach (var cake in allCakes)
    {
        <MudItem xs="3">
            <MudCard>
                <MudCardHeader>
                    <CardHeaderContent>
                        <MudText Typo="Typo.body1">@cake.Name</MudText>
                        <MudText Typo="Typo.h6">@cake.Price $</MudText>
                    </CardHeaderContent>
                </MudCardHeader>
                <MudCardMedia Image="images/sample-cake.jpg" Height="250" />
                <MudCardContent>
                    <MudText Typo="Typo.body2">@cake.Description</MudText>
                </MudCardContent>
                <MudCardActions>
                    <MudIconButton Icon="@Icons.Filled.Edit" Color="Color.Primary" />
                    <MudIconButton Icon="@Icons.Filled.Delete" Color="Color.Error" />
                </MudCardActions>
            </MudCard>

        </MudItem>

    }

</MudGrid>
  • (Line: 2) Injected the 'MyWorldDbContext'.
  • (Line: 4) Rendered the 'MudGrid' component. Here applied padding right&left like 'class="pr-4 pl-4"'.
  • (Line: 5-27) Looping the collection of records by rendering the 'MudItem' component, inside it renders the 'MudCard' component.
  • (Line: 15) Added a dummy image for display purposes(image added in folders of  'wwwroot/images').
Index.razor:(C# Code) 
@code {
    List<Cake> allCakes = new List<Cake>();
    protected  override async Task OnInitializedAsync()
    {
        allCakes = await _myworldDbContext.Cake.ToListAsync();
    }
}
  • (Line: 2)Initialized the collection of 'Cake' instance.
  • (Line: 3-6) The 'OnInitialized' life cycle method invokes the database call to fetch all the records.

 Create Operation:

Let's implement logic to add a new record to the database.

Now let's create dialog components like 'AddOrUpdateCakeDailog.razor'.
Pages/AddOrUpdateCakeDailog.razor:(HTML Part)
<MudDialog>
    <DialogContent>
        <MudTextField T="string" Label="Name" @bind-Value="cake.Name" />
        <MudTextField T="decimal" Label="Price" @bind-Value="cake.Price" />
        <MudTextField T="string" Label="Description" @bind-Value="cake.Description" Lines=4/>
    </DialogContent>
    <DialogActions>
        <MudButton OnClick="Cancel">Cancel</MudButton>
        <MudButton Color="Color.Primary" OnClick="Submit">Ok</MudButton>
    </DialogActions>
</MudDialog>
  • (Line: 1&11)Here added the 'MudDialog' component. 
  • (Line: 3&4) The 'MudTextField' component for the text fields and '@bind-value' for 2-way binding.
  • (Line: 5) The 'MudTextField' component can be rendered as multi-line text filed by adding attributes like 'Lines'.
  • (Line: 8) Added 'Cancel' button and its click event with 'Cancel' method.
  • (Line: 9) Added 'Ok' button and its click event with 'Submit' method.
Pages/AddOrUpdateCakeDailog.razor:(c# Part)
@code {
    [CascadingParameter] MudDialogInstance MudDialog { get; set; }

    [Parameter] public Cake cake { get; set; } = new Cake();

    private void Cancel()
    {
        MudDialog.Cancel();
    }

    private void Submit()
    {
        MudDialog.Close(DialogResult.Ok<Cake>(cake));
    }
}
  • (Line: 2) The 'MudDialogInstance' property gives control over the dialog.
  • (Line: 4) The 'cake' property instance is used to bind the dialog fields and the instance of the property comes from the component that invokes the dialog.
  • (Line: 6-9) The 'Cancel' method to close the dialog.
  • (Line: 11-14) The 'Submit' method closes the dialog as well passe the dialog information to a component that invokes the component.
Index.razor:(HTML Part)
@page "/"
@inject MyWorldDbContext _myworldDbContext;
@inject IDialogService _dialogService;

<MudContainer Class="d-flex justify-center mb-2">
    <MudFab Color="Color.Primary" Icon="@Icons.Material.Filled.Add" Size="Size.Large" IconSize="Size.Large" Label="Add A New
    Cake" Class="ma-2" @onclick="(e => CreateAsync())" />
</MudContainer>
<MudGrid Justify="Justify.Center" class="pr-4 pl-4">
   <!-- Code hidden for display purpose -->
</MudGrid>
  • (Line: 3) Injected the 'IDialogService'.
  • (Line: 5-8) Add button, its click event registered with 'CreateAsync()' method.
Index.razor:(C# Part)
private async Task CreateAsync()
{
	var parameters = new DialogParameters();
	parameters.Add("cake", new Cake());
	var dialog = await _dialogService.Show<AddOrUpdateCakeDialog>("Create A Post", parameters).Result;

	if (dialog.Data != null)
	{
		Cake newCake = dialog.Data as Cake;
		_myworldDbContext.Cake.Add(newCake);
		await _myworldDbContext.SaveChangesAsync();

		allCakes.Insert(0, newCake);
	}
}
  • (Line: 3-4) The 'DialogParameters' instance needs to use for adding parameters that can be sent to the dialog.
  • (Line: 5) Using the 'IDialogService' we can open dialog by calling 'Show<T>()' where T(type) will be the dialog component. The 'Show<T>' has 2 params where 1st parameter will be the title for the dialog and 2nd parameter will be the data that passed to the dialog component.
  • (Line: 7) Checking for data coming from the dialog.
  • (Line: 9-11) Using entity framework database context saves the new record to the database.
  • (Line: 13) Now updating the 'allCakes' collection property with our newly created record.


Update Operation:

Let's implement our logic to update the record.
Index.razor:(HTML Part)
<MudCardActions>
	<MudIconButton Icon="@Icons.Filled.Edit" Color="Color.Primary" @onclick="(e => UpdateAsync(cake.Id))" />
	<MudIconButton Icon="@Icons.Filled.Delete" Color="Color.Error" />
</MudCardActions>
  • (Line: 2) The edit button registers with the 'UpdateAsync' click event.
Index.razor:(C# Part) 
private async Task UpdateAsync(int id)
{
	var parameters = new DialogParameters();
	var cakeNeedToUpdate = allCakes.FirstOrDefault(_ => _.Id == id);
	parameters.Add("cake", cakeNeedToUpdate);
	var dialog = await _dialogService.Show<AddOrUpdateCakeDialog>("Update A Item", parameters).Result;
	if (dialog.Data != null)
	{
		var updatedCake = dialog.Data as Cake;
		_myworldDbContext.Cake.Update(updatedCake);
		await _myworldDbContext.SaveChangesAsync();

		allCakes.Remove(cakeNeedToUpdate);
		allCakes.Insert(0, updatedCake);
	}
}
  • (Line: 3-5) Adding the record that needs to be updated as a parameter to the 'DailogParamters'.
  • (Line: 9-11) Saving modified changes to the database.


Delete Operation:

Let's implement our logic to remove the record from the database.
Index.razor:(Html Part)
<MudCardActions>
	<MudIconButton Icon="@Icons.Filled.Edit" Color="Color.Primary" @onclick="(e => UpdateAsync(cake.Id))" />
	<MudIconButton Icon="@Icons.Filled.Delete" Color="Color.Error" @onclick="(e => DeleteAsync(cake.Id))" />
</MudCardActions>
  • (Line: 3) The 'Delete' button registered with 'DeleteAsync' click event
Index.razor:(C# Part) 
private async Task DeleteAsync(int id)
{
	bool? result = await _dialogService.ShowMessageBox(
	"Delete Confirmation",
	"Deleting can not be undone!",
	yesText: "Delete!", cancelText: "Cancel");

	if (result ?? false)
	{
		var cakeToRemove = await _myworldDbContext.Cake.FindAsync(id);
		_myworldDbContext.Cake.Remove(cakeToRemove);
		await _myworldDbContext.SaveChangesAsync();

		allCakes.Remove(cakeToRemove);
	}
}
  • (Line: 3-6) MudBlazor 'MessageBox' are simple popups that can be easily used like 'warning' or 'confirmation' popups. So 'MessageBox' is also invoked by using 'IDialogService'. MessageBox on click 'cancelText' button returns 'null', if we click 'yesText' button then it returns 'true' value.
  • (Line: 10-12) Deleting the record from the database.

Support Me!
Buy Me A Coffee PayPal Me

Video Session:

Wrapping Up:

Hopefully, I think this article delivered some useful information on Blazor Server CRUD operations Using MudBlazor UI components. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Labels:

Comments

  1. AnonymousSeptember 1, 2022 at 2:33 PM

    Thank you for this wonderful and clear explanation tutorial

    ReplyDelete
  2. CasperOctober 13, 2022 at 4:38 PM

    I received an error for the Pages/Index.razor: CS0103 The name 'allCakes' does not exist in the current context
    It is from "@foreach (var cake in allCakes)".
    Could you help on this error? Thank you.

    ReplyDelete

Post a Comment

Popular posts from this blog

.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
6 comments
Read more

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'
3 comments
Read more

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
Post a Comment
Read more

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
6 comments
Read more

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
7 comments
Read more

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
7 comments
Read more

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in
2 comments
Read more

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider
6 comments
Read more

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-Control Pragma Vary 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 fr
Post a Comment
Read more

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
4 comments
Read more