Skip to main content

Generic Typed Components Using Templated Components In Blazor


What Are Templated Components? :

One or more UI templates as a component parameter of type RenderFragment or RenderFragment<T>. A RenderFragment represents a chunk of UI to render.

RenderFragment Parameter:

RenderFragment parameters render the chunk of UI in a component. RenderFragment type parameter name must match with Html tag element.

Pages/Card.razor(Html Portion):

<h3>Card</h3>
<div class="card text-center">
    @CardHeader
    @CardBody
    @CardFooter
</div>

Pages/Card.razor(@code Portion):

@code {
    [Parameter]
    public RenderFragment CardHeader { get; set; }
    [Parameter]
    public RenderFragment CardBody { get; set; }
    [Parameter]
    public RenderFragment CardFooter { get; set; }
}
@CardHeader, @CardBody @CardFooter are Templated Component parameters of type RenderFragment.

Pages/Index.razor:

<Card>
    <CardHeader>
        <div class="card-header">
           My Templated Component
        </div>
    </CardHeader>
    <CardBody>
        <div class="card-body">
            <h5>Welcome To Template Component</h5>
        </div>
    </CardBody>
    <CardFooter>
        <div class="card-footer text-muted">
            Click Here
        </div>
    </CardFooter>
    
</Card>
Each Templated Component Parameter of type RenderFragment will have a corresponding Html tag element. The Html tag element must match with the parameter name.

Rendered OutPut:

Duplicate Html Tags:

The Html tag that represents the Templated component Parameter, duplicating it will result in rendering the last or bottom Html tag as a priority.

Pages/Index.razor:

<Card>
    <CardHeader>
        <div class="card-header">
            Templated Component
        </div>
    </CardHeader>
    <CardHeader>
        <div class="card-header">
            Hi I'm duplicated header
        </div>
    </CardHeader>
</Card>

Rendered Output:

Typed RenderFragment<T> Parameter:

  • RenderFragmetnt<T> a typed parameter represents to render the chunk of UI template along with some dynamic content from the type it implements.
  • Declare generic type parameter at the top of the component using @typeparam. This represents the component type at runtime.
  • This type of typed component parameter which passed as the element will have an implicit parameter called 'context'. 
  • Context implicit parameter helps in dynamic data binding. It has access to the property type that implemented by RenderFragment<T>.

Pages/Card.razor(Html Portion):

@typeparam TItem
<div class="card text-center">
    @CardHeader(Item)
    @CardBody(Item)
    @CardFooter
</div>

Pages/Card.razor(@code Portion):

@code {
    [Parameter]
    public TItem Item { get; set; }
    [Parameter]
    public RenderFragment<TItem> CardHeader { get; set; }
    [Parameter]
    public RenderFragment<TItem> CardBody { get; set; }
    [Parameter]
    public RenderFragment CardFooter { get; set; }
}
CardHeader, CardBody are component parameters of type RenderFragment<T>. These properties templated Html have access to implicit parameter 'context' for dynamic binding data.

Pages/Index.razor(Html Portion):

<Card Item="Cake">
    <CardHeader>
        <div class="card-header">
            Cake Token Number - @context.Id
        </div>
    </CardHeader>
    <CardBody>
        <div class="card-body">
            <div>@context.Name</div>
            <div>$ @context.Cost</div>
        </div>
    </CardBody>
    <CardFooter>
        <div class="card-footer text-muted">
            Click Here
        </div>
    </CardFooter>
</Card>
Dynamic data binding inside the templated Html elements using implicit parameter 'context'.

Pages/Index.razor(@code Portion):

@code{
    private Cake Cake = new Cake
    {
    Id = 1,
    Name = "Black Forest",
    Cost = 50
    };
}

Models/Cake.cs:

public class Cake
{
 public int Id { get; set; }
 public string Name { get; set; }
 public decimal Cost { get; set; }
}

Rendered Output:

Context Attribute On Templated Html Element:

In the templated Html element, context can be declared explicitly as the Html attribute. The value assigned to the Context (Html attribute) will be used for dynamic binding in the templated Html element.



    Declaring Context attribute at the Component Html element level.

    Pages/Index.razor:

    <Card Item="Cake" Context="cakeContext">
        <CardHeader>
            <div class="card-header">
                Cake Token Number - @cakeContext.Id
            </div>
        </CardHeader>
        <CardBody>
            <div class="card-body">
                <div>@cakeContext.Name</div>
                <div>$ @cakeContext.Cost</div>
            </div>
        </CardBody>
    </Card>
    

    Declaring Context attribute at the each templated Html level.

    Pages/Index.razor:

    <Card Item="Cake">
        <CardHeader Context="headContext">
            <div class="card-header">
                Cake Token Number - @headContext.Id
            </div>
        </CardHeader>
        <CardBody Context="bodyContext">
            <div class="card-body">
                <div>@bodyContext.Name</div>
                <div>$ @bodyContext.Cost</div>
            </div>
        </CardBody>
    </Card>
    
    'headContext', 'bodyContext' are context parameters of templated Html.

    Generic-typed Templated Component:

    Templated component itself a generic typed component. @typeparam to define the type of the generic component. Generic-typed templated component will be defined by our own implementation of it and how it can be reused for different types.

    The best choice of its implementation Generic-typed component is like the component with only two properties. The first property is of type RenderFragment<T> templated property to render the Html. The Second property is of type List<T> a collection of data to be bind to the rendered Html. 

    The most widely used scenarios for the Generic-typed templated component is of display items, it will help to avoid to create new components for displaying items in an application. Single component for all display items.

    Pages/ShowItems.razor(Html portion):

    @typeparam TItem
    
    <div>
    @if ((Items?.Count ?? 0) != 0)
    {
     @foreach (var item in Items)
     {
      @ShowTemplate(item);
     }
    }
    </div>
    

    Pages/ShowItems.razor(@code portion):

    @code {
    
    [Parameter]
    public RenderFragment<TItem> ShowTemplate { get; set; }
    
    [Parameter]
    public List<TItem> Items { get; set; }
    
    }
    
    ShowTemplate and Items are two parameters of our generic-typed component. ShowTemplate is of type RenderFragment property which will render Html to display (this Html can be table, list, content, etc,). Items are collection property whose type is matches with our component type, this data will be used in the data binding inside of our rendered Html.

    Pages/Index.razor(Html portion):

    <ShowItems Items="Cakes" >
        <ShowTemplate Context="CakeContext">
            <div class="card text-center">
                <div class="card-header">
                    Cake Token Id - @CakeContext.Id
                </div>
                <div class="card-body">
                    <h5 class="card-title">@CakeContext.Name</h5>
                    <p class="card-text">Price $@CakeContext.Cost</p>
                </div>
                <div class="card-footer text-muted">
                    Click Here
                </div>
            </div>
        </ShowTemplate>
    </ShowItems>
    
    ShowItems template represents our generic-typed component. ShowTemplate represents component Html rendering property.

    Pages/Index.razor(@code portion):

    @code{
        public List<Cake> Cakes { get; set; }
    
        protected override Task OnAfterRenderAsync(bool firstRender)
        {
            LoadCakes();
            StateHasChanged();
            return base.OnAfterRenderAsync(firstRender);
        }
    
        public void LoadCakes()
        {
            Cakes = new List<Cake>
            {
                // items hidden for display purpose
                new Cake
                {
                    Id = 1,
                    Name = "Red Velvet",
                    Cost = 60
                },
            };
        }
    }
    
    Inside life cycle method 'OnAfterRenderAsync' method, calling 'StageHasChanged()' method to reflect the data changes in component. You can try removing the 'StateHasChanged()' method where we can observe an empty page without displaying data because we are populating data ofter rendering Html.

    Rendered Output:

    Using HttpClient:

    In Blazor application, data will be consumed by calling Web API using 'System.Net.Http.IHttpClientFactory'. 

    To serialize or deserialize the JSON data from an API using NewtonSoft.Json Nuget.
         Install-Package Newtonsoft.Json -Version 12.0.3 

    IHttpClientFactory can be used by injecting from the constructor. To inject it need to register HttpClient services in the Startup.cs

    Startup.cs:

    public void ConfigureServices(IServiceCollection services)
    {
     // hiden code for display purpose
     services.AddHttpClient();
    }
    

    Add Logic file to fetch the data from an API

    Logic/CakeLogic.cs:

      using System.Collections.Generic;
    using System.Net.Http;
    using System.Threading.Tasks;
    using Blazor.TemplateComponent.App.Models;
    using Newtonsoft.Json;
    
    namespace Blazor.TemplateComponent.App.Logic
    {
        public class CakeLogic : ICakeLogic
        {
            private readonly IHttpClientFactory _httpClientFactory;
    
            public CakeLogic(IHttpClientFactory httpClientFactory)
            {
                _httpClientFactory = httpClientFactory;
            }
    
            public async Task<IList<Cake>> GetAll()
            {
                HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44316/api/cake/get");
    
                var httpClient = _httpClientFactory.CreateClient();
    
                HttpResponseMessage responseMessage = await httpClient.SendAsync(request);
                if (responseMessage.IsSuccessStatusCode)
                {
                    string data = await responseMessage.Content.ReadAsStringAsync();
                    if (!string.IsNullOrEmpty(data))
                    {
                        return JsonConvert.DeserializeObject<List<Cake>>(data);
                    }
                }
                return null;
            }
    
        }
    }
    

    Logic/ICakeLogic.cs:

    using System.Collections.Generic;
    using System.Threading.Tasks;
    using Blazor.TemplateComponent.App.Models;
    
    namespace Blazor.TemplateComponent.App.Logic
    {
        public interface ICakeLogic
        {
            Task<IList<Cake>> GetAll();
        }
    }
    

    Now register the logic files in a startup.cs file so that the logic files can be injected anywhere in the application.

    Startup.cs:

    public void ConfigureServices(IServiceCollection services)
    {
     // hidden code for display purpose
     services.AddSingleton<ICakeLogic, CakeLogic>();
     services.AddHttpClient();
    }
    

    Add required namespaces globally in _Import.razor.

    _Import.razor:

    @using Blazor.TemplateComponent.App.Models
    @using Blazor.TemplateComponent.App.Logic
    

    Now update the Index. razor file to consume the data from the API.

    Index.razor(@Html Portion):

     
    @inject ICakeLogic _cakeLogic
    

    Index.razor(@code Portion):

    @code{
        public List<Cake> Cakes { get; set; }
    
        protected override async Task OnAfterRenderAsync(bool firstRender)
        {
            await LoadCakes();
            StateHasChanged();
            await base.OnAfterRenderAsync(firstRender);
        }
    
        public async Task LoadCakes()
        {
            var result = await _cakeLogic.GetAll();
            Cakes = result.ToList();
        }
    }
    

    Render Output:

    Wrapping Up:

    Hopefully, this article will help you with an understanding of Blazor Templated Component and Generic-Typed Templated Component. I will love to have your feedback, suggestions, and better techniques in the comments section.

    Source Code:

    Follow Me:

    Comments

    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

    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

    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

    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

    .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

    .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

    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

    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

    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