Skip to main content

Blazor WebAssembly File Upload Using MudBlazor UI Components

In this article, we are going to implement a Blazor WebAssembly application file upload using MudBlazor UI components.

Create A Sample Blazor WebAssembly Application:

Let's create a sample Blazor WebAssembly application to accomplish our demo on file uploading.



Initial MudBlazor Setup:

Install the 'MudBlazor' library package.

Add Mudblazor namespace into the '_Imports.razor'.
_Imports.razor:
@using MudBlazor
Add the below CSS files inside of the head tag in 'index.html'.
wwwroot/index.html:
<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 comment the 'bootstrap.min.css' and '{your_applicationname}.styles.css' links in the head tag.

Add MudBlazor javascript file in 'index.html' just above the closing body tag.
wwwroot/index.html:
<script src="_content/MudBlazor/MudBlazor.min.js"></script>
Register MudBlazor service in 'Program.cs'.
Program.cs:
builder.Services.AddMudServices();
Now let's add some styling to 'MainLayout.razor' file with help MudBlazor components like 'MudThemeProvider', 'MudAppBar', 'MudText', etc.
Shared/MainLayout.razor:
@inherits LayoutComponentBase
<MudThemeProvider />
<div class="page">
    <MudAppBar Color="Color.Info">
        <MudText Typo="Typo.h4">File Upload Demo</MudText>
    </MudAppBar>

    <div class="main mt-12" >
        <div class="content px-4">
            @Body
        </div>
    </div>
</div>
Now our application looks as below.

MudBlazor To Compose File Upload:

Using HTML elements like 'label', 'input' we can create a file upload button.

The 'for' attribute value of the label must match with 'id' value of the 'input', we enable the 'input' to be triggered by clicking on the label. So the trick is to style the label to like like a button and hide the input.

Blazor WebAssembly from .Net 3.1 provides a default blazor component for file upload like 'InputFile'. So we can use 'InputFile' component instead of HTML 'input' filed.

We can make 'MudButton' component as a 'HTML' label element to do that 'MudButton' has an attribute like 'HtmlTag' and its value should be set like 'label'. By doing this HTML label getts rendered with all the beautiful styles of the MudBlazor button.

Implement File Upload Blazor Component Logic:

Let's first create the model class like 'SaveFile.cs' to capture the uploaded files.
Models/SaveFile.cs:
using System.Collections.Generic;

namespace Bwasm.MudFileUpload.UI.Models
{
    public class SaveFile
    {
        public SaveFile()
        {
            Files = new List<FileData>();
        }
        public List<FileData> Files { get; set; }
    }

    public class FileData
    {
        public byte[] ImageBytes { get; set; }
        public string FileName { get; set; }
        public string FileType { get; set; }
        public long FileSize { get; set; }
    }
}
Let's implement our logic in to the 'Index.razor' file. So let's update the 'Index.razor' as below.
Pages/Index.razor:(HTML Part)
@page "/"
<MudPaper Class="d-flex justify-center py-2 px-1 mt-6">
    <InputFile id="fileInput" OnChange="UploadFiles" hidden multiple />
    <MudButton HtmlTag="label"
               Variant="Variant.Filled"
               Color="Color.Success"
               StartIcon="@Icons.Filled.CloudUpload"
               for="fileInput">
        Upload Files
    </MudButton>
</MudPaper>

@if ((saveFile?.Files?.Count ?? 0) > 0)
{
    <MudPaper Class="d-flex justify-center py-2 px-1">
        @foreach (var item in saveFile?.Files)
        {
            <MudPaper Class="pa-2 mx-2">
                <MudIconButton Color="Color.Error" Icon="@Icons.Material.Filled.Delete" OnClick="@(_ => RemoveImg(item))" aria-label="delete"></MudIconButton>

                <img width="150" height="150" src="@($"data:{item.FileType};base64,{Convert.ToBase64String(item.ImageBytes)}")">
            </MudPaper>
        }
    </MudPaper>
}
  • (Line: 3-10) Using 'InputField' and 'MudButton' we are creating the file upload UI. Here on 'InputFile' component we added attributes like 'hidden'(to hide the HTML), 'multiple' (enables multiple images to upload). On 'MudButton' we must define the 'HtmlTag' and its value should be 'label'. On 'MudButton' component 'for' attribute value must be match with the 'id' value of the 'InputFile' component. The 'InputFile' component registered 'OnChange' event with 'UpLoadFiles' method.
  • (Line: 13-25) Preview section of the uploaded images.
  • (Line: 19) Delete button to remove the selected image. Button registered with a 'RemoveImg' method.
  • (Line: 21) Previewing the selected image.
Pages/Index.razor:(C# Part)
@code{
    SaveFile saveFile = new SaveFile();
    private async Task UploadFiles(InputFileChangeEventArgs e)
    {
        foreach (var file in e.GetMultipleFiles())
        {

            var fileData = new FileData();
            var buffers = new byte[file.Size];
            await file.OpenReadStream().ReadAsync(buffers);
            fileData.FileName = file.Name;
            fileData.FileSize = file.Size;
            fileData.FileType = file.ContentType;
            fileData.ImageBytes = buffers;
            saveFile.Files.Add(fileData);
        }
    }

    private void RemoveImg(FileData file)
    {
        saveFile.Files.Remove(file);
    }
}
  • (Line: 2) Initialized the 'SaveFile' object to store the uploaded images.
  • (Line: 3-17) The 'UploadFiles' method registered with the 'OnChange' event of the 'InputFile' component.
  • (Line: 10) Fetching the image as bytes of data.
  • (Line: 19-22) Remove the selected image from the preview.
Now run the application and check the output.

Create API Endpoint To Save Files To Physical Location:

Create another sample .NetCore Web API application. Then we will create an endpoint to save the files to a physical location on the server. This endpoint will be consumed by our Blazor Assembly application.

Now create a payload object for our endpoint as below.
Models/SaveFile.cs:
using System.Collections.Generic;

namespace Bwasm.MudFileUpload.API.Models
{
    public class SaveFile
    {
        public SaveFile()
        {
            Files = new List<FileData>();
        }
        public List<FileData> Files { get; set; }
    }

    public class FileData
    {
        public byte[] ImageBytes { get; set; }
        public string FileName { get; set; }
        public string FileType { get; set; }
        public long FileSize { get; set; }
    }
}
Now write an endpoint that has an implementation of saving the file to the physical folder location.
Controllers/FileUpLoadController.cs:
using Bwasm.MudFileUpload.API.Models;
using Microsoft.AspNetCore.Mvc;
using System;
using System.Threading.Tasks;

namespace Bwasm.MudFileUpload.API.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class FileUploadController : ControllerBase
    {
        [HttpPost]
        [Route("save-file-to-physicallocation")]
        public async Task<IActionResult> SaveToPhysicalLocation([FromBody] SaveFile saveFile)
        {
            foreach (var file in saveFile.Files)
            {
                string fileExtenstion = file.FileType.ToLower().Contains("png") ? "png" : "jpg";
                string fileName = $@"D:\MyTest\{Guid.NewGuid()}.{fileExtenstion}";
                using (var fileStream = System.IO.File.Create(fileName))
                {
                    await fileStream.WriteAsync(file.ImageBytes);
                }
            }
            return Ok();
        }
    }
}
  • (Line: 16) Looping the collection of file information.
  • (Line: 19) The full path of the file name. It is always recommended to save the files in non-application folder on the server.
  • (Line: 20) The 'System.IO.File.Create("image_path")' generates the file stream at the specified path.
  • (Line: 22) Saving the files array of byte data to the specified physical path.
To consume this endpoint by our Blazor Application enable cors.
Startup.cs:
public void ConfigureServices(IServiceCollection services)
{

   
	services.AddCors(options =>
	{
		options.AddPolicy(name: "MyAllowSpecificOrigins",
		  builder =>
		  {
			  builder.AllowAnyOrigin();
			  builder.AllowAnyHeader();
			  builder.AllowAnyMethod();
		  });
	});
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
	app.UseCors("MyAllowSpecificOrigins");
}

Invoke API Endpoint From Blazor WebAssembly Application:

Add our web API domain to HttpClient configuration in Program.cs file.
Program.cs:
builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri("https://localhost:6001/") });
Now lets add new button to upload the images to server.
Pages/Index.razor:(Html Part)
@page "/"
@inject HttpClient Http

<MudPaper Class="d-flex justify-center py-2 px-1 mt-6">
    <InputFile id="fileInput" OnChange="UploadFiles" hidden multiple />
    <MudButton HtmlTag="label"
               Variant="Variant.Filled"
               Color="Color.Success"
               StartIcon="@Icons.Filled.CloudUpload"
               for="fileInput">
        Upload Files
    </MudButton>
    <MudButton OnClick="SaveToServer"
               Variant="Variant.Filled"
               Color="Color.Warning"
               StartIcon="@Icons.Filled.CloudUpload"
               for="fileInput">
        Upload Files To Server
    </MudButton>
</MudPaper>
  • (Line: 2) Inject the 'HttpClient'.
  • (Line: 13-19) Add new button that will invoke the API call for uploading the image to the server. Here click event registered with 'SaveToServer' method.
Pages/Index.razor:(C# Part)
private async Task SaveToServer()
{
	await Http.PostAsJsonAsync("/api/FileUpload/save-file-to-physicallocation", saveFile);
}
Wr

Support Me!
Buy Me A Coffee PayPal Me

Video Session:

Wrapping Up:

Hopefully, I think this article delivered some useful information on the Blazor WebAssembly File Upload using MudBalzor UI Components. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

  1. I need better performence. Can I cache files on server side?

    ReplyDelete

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