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

Post a Comment

Popular posts from this blog

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

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

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", defaul

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 bel

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

.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 f

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

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: PickerController PickerOptions 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&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http

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. T