Skip to main content

A Sample On Blazor WebAssembly Virtualization Component

  • The 'Virtualize' pre-build Blazor component was shipped from .Net5 framework. 
  • The concept behind making a virtualization component is to render the HTML content within the are of the viewport(i.e, visible area on a page). 
  • The most useful case to use this 'Virtualize' component is to display huge table content of data, by using this component renders the huge data as parts of data based on visible area dynamically. 
  • This dynamic loading data rendering will happen on scroll-up and scroll-down event implicitly nothing to worry about by us. 
  • This makes our website UI more user-friendly to render huge data without any UI delay.

Create A Sample WebAssembly Application:

The virtualization component can be used either in Blazor Server or Blazor WebAssembly applications. Here we are going to create a sample application using the Blazor WebAssembly template. For developing our sample application we can use any IDE of your choice but the most recommended are Visual Studio 2019(Supported VS for .Net5) or Visual Studio Code.

Implementation Technique Of Virtualize Blazor Component:

The Virtualize Blazor Component can be implemented in two different ways:
  • Items (Property)
  • ItemProvider(delegate)
Items (Property) - The Virtualize component has the property 'Items' which accepts the collection of our data to be displayed. On passing our data to the 'Items' property the 'Virtualize' component will take of everything to render the data as parts depend on the visible area. So in this technique, we have to fetch all our data in a single API call and assigned it to the 'Items' property.

ItemProvider(delegate)- The Virtualize component has a delegate or callback event called 'ItemProvider'. This technique involves multiple API calls, which loads data per API call almost similar to the pagination technique but here data loads on the scroll. (Note:- My recommendation is to avoid this technique for production code because there few drawbacks, so if you interested in multiple API calls it's good to use the pagination approach. Might be it will be ready to use for production in the next release of .Net, until then avoid it. ).

A Sample Virtualize Component With Items Property:

Let's create a Virtualize component with a sample of fake data as follow.
Pages/Example.razor:(Html Part)
@page "/example"
<div>
  <table class="table table-striped">
   <thead>
	<tr>
	 <th scope="col">My Todos</th>
	</tr>
   </thead>
   <tbody>
	<Virtualize Context="todo" Items="todos">
	 <tr>
	  <td>
		@todo
	  </td>
	 </tr>
	</Virtualize>
   </tbody>
  </table>
</div>
  • (Line: 10-16) The 'Virtualize' component rendered.
  • (Line: 10) The 'Items' property caries our data collection that going to rendered parts by parts based on visible area and page scroll.
  • (Line: 10) The 'Context' specifies the parameter name for all child content expression.  Using the name of the 'Context' parameter is used to bind the content inside of the component, in our example context is named as 'todo', the 'todo' is used for the binding. If we don't specify the name for the 'context' parameter then we have to use it directly inside of HTML for binding like '@context'.
  • (Line: 13) Binding my todos data, since it is a simple string we used '@todo', for example, if it is an object then we have to bind like '@todo.Item', etc.
Pages/Example.razor:(Code Block Part)
@code
{
  private List<string> todos = new List<string>();
  protected override async Task OnInitializedAsync()
  {
	for (int i = 0; i < 200; i++)
	{
          todos.Add($"My Itesm {i}");
	}
	await Task.FromResult(0);
  }
}
Here I'm creating some collection todos fake data.
Let's check the rendered output as follows
Here on the left screen on the initial load, we can observe top item rendered is "My Item 0", after scrolling the page right screen the top item rendered is "My Item 4" now if you carefully understand and observe there will be no "My Item 0", "My Item 1", etc in the rendered element. This proves that the 'Virtualize' component renders the in-memory collection of data parts by parts on basis of visible UI.

Create .Net5 Web API Sample:

Now we will create an API application that will be used by our blazor application where we replace the fake todos data with API data.
Note:
IF you have an existing API or If you have idea how to create an API just skip this section.
My sample endpoint looks something like below.
[Route("get-all")]
[HttpGet]
public async Task<IActionResult> AllTodos()
{
  using (IDbConnection conn = Connection)
  {
   string query = @"
   SELECT
   Id,
   ItemName as Title,
   IsCompleted as Completed
   FROM Todo Order by Id ASC";

   var result = (await conn.QueryAsync<Todo>(sql: query)).ToList();
   return Ok(result);
  }
}
Here I'm fetching all todos records from my database, in this sample I used Dapper ORM to communicate with the database. Click here for implementing API using Dapper ORM.
My endpoint looks something like below.

Virtualization Component Items Property With API Data:

Now let's change our sample by consuming real API endpoint data to display inside of the virtualization component.

Now let's create our Typed HttpClient class as below
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Json;
using System.Threading.Tasks;
using Blazorwasm.VirtualComponent.Sample.Models;

namespace Blazorwasm.VirtualComponent.Sample.Clients
{
  public class TodoClient
  {
   private readonly HttpClient _httpClient;
   public TodoClient(HttpClient httpClient)
   {
	_httpClient = httpClient;
   }
   public async Task<List<Todos>> GetAll()
   {
	var todos = await _httpClient.GetFromJsonAsync<List<Todos>>("/todos/get-all");
	return todos;
   }
  }
}
Here we created HttpClient using the Typed technique, here we implemented our logic to fetch 'Todos' API data. Click here to understand different techniques to consume the web APIs in the Blazor application.

Now install the below package to register our Typed HttpClient in the Program.cs file.
Package Manager:
Install-Package Microsoft.Extensions.Http
.Net CLI
dotnet add package Microsoft.Extensions.Http
Now register our Typed HttpClient in the Program.cs file as below.
Program.cs:
builder.Services.AddHttpClient<TodoClient>(client =>
{
  client.BaseAddress = new Uri("https://localhost:6001");
});
  • Along with our typed HttpClient 'TodoClient,' we registered our API base address.
Now update our component to consume API.
Pages/Example.razor:(Html Part)
@page "/example"
@inject TodoClient _todoClient
<div>
  <table class="table table-striped">
   <thead>
	<tr>
	 <th scope="col">Id</th>
	 <th scope="col">Title</th>
	 <th scope="col">Completed</th>
	 </tr>
   </thead>
   <tbody>
	<Virtualize Context="todo" Items="todos">
	 <tr>
	  <td>
		@todo.Id
	  </td>
	  <td>
		@todo.Title
	  </td>
	  <td>
		@todo.Completed
	  </td>
	 </tr>
	</Virtualize>
   </tbody>
  </table>
</div>
  • (Line: 2) Our 'TodoClient' type HttpClient injected(make sure to import the 'TocoClient' namespace in _Import.razor file)
  • (Line: 13-25) The 'Virtualize' component declared and assigned our 'todos' collection to the 'Items' property.
Pages/Example.razor:(Code Block Part)
@code
{
  private List<Todos> todos = new List<Todos>();

  protected override async Task OnInitializedAsync()
  {
	todos = await _todoClient.GetAll();
  }
}
  • Fetching API data and assigning to 'todos' property which will be consumed by 'Virtualize' components Item property.
Here from the image, we understand the parts by parts rendering of data by the Virtualize component on scrolling up and down with minimum Html rendering.

That's all about the Virtualization Component in Blazor WebAssembly Application. 

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on Blazor WebAssembly Virtualization Component. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Comments

  1. Can virtualization be used with cards for example? Or this works only with tables? I want to display a page of products, 3 cards in a row.

    ReplyDelete
    Replies
    1. Virtualization works based on the Item heights, In row with single card it might work, but with multiple cards in single row might not works.

      Delete
  2. I have clicked inside virtualize data, but scroll again moved to top instead of pointing the particula content.

    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

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

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

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