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:

    Labels:

    Comments

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

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

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

    .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 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
    8 comments
    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
    7 comments
    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
    6 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

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