Skip to main content

A Brief Tour On .NET Core View Components



  • View Components are small pieces or chunks of a reusable block of code.  
  • A View Component is made of the class(Component Class) and a view that looks like Controller. But View Component can't be triggered or initialized by a user request like MVC Controller, it will be invoked from code manually.
  • A View or Razor can be completely or partially build using View Components.

Create A .Net Core MVC Sample:

Let's understand View Components by doing simple examples on it. So let's create a sample .Net Core MVC application(another choice to use like Razor Pages sample application). Use either Visual Studio 2019(IDE supports .Net Core 3.0 plus version) or Visual Studio Code.

Implement The View Component Class:

View Component Class is the logic container where we can prepare data that need to be bind to view on the render. Create a folder like ViewComponents where will create all our application components.

A POCO class that inherits Microsoft.AspNetCore.Mvc.ViewComponent can be called a View Component class. As of good coding standards, it is recommended to suffix the POCO class name as 'ViewComponent' like eg:- 'YourComponentNameViewComponent'.
ViewComponents/StudentViewComponent.ts:
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;

namespace SampleViewComponent.App.ViewComponents
{
    public class StudentViewComponent : ViewComponent
    {

    }
}

Invoke Or InvokeAsync Methods Of View Component:

On Calling or invoking View Component the only method that executed automatically is Invoke or InvokeAsync. Any logic or data accessing calls are implemented in this method. Invoke or InvokeAsync method return type is Microsoft.AspNetCore.Mvc.IViewComponentResult. An IVewComponentResult can accept either Html(View or Razor Page) or Plain String.
ViewComponents/StudentViewComponent.ts:
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;

namespace SampleViewComponent.App.ViewComponents
{
    public class StudentViewComponent : ViewComponent
    {
        public async Task<IViewComponentResult> InvokeAsync()
        {
            return Content("Hi I'm Student Component");
        }
    }
}
#L10 at this line number retuning method ViewComponent.Content() which returns a plain string as View Component output. In real-time scenarios, most cases return a razor view using ViewComponent.View() which is an overloaded method.

Calling View Component From *.cshtml:

View Component is like building blocks of a page and most appropriate way to call or invoke them from an MVC View or from a Razor Page View. IViewComponentHelper of razor view helper helps to invoke any View Component within the application by passing component name as an input parameter.

Let's test our sample View Component by calling it on Index.cshtml(HomeController View) as follows.
Views/Home/Index.cshtml:
@{
    ViewData["Title"] = "Home Page";
}

<div class="text-center">
   @await Component.InvokeAsync("Student")
</div>
#L6 - asynchronous call for View Component, if we want we can do synchronous call but it is recommended to use async call. If we observe name of the component is passed as an input parameter so that particular View Component result gets rendered. The original name of our View Component class is 'StudentViewComponent', but while calling we removed suffix('ViewComponent') because .Net will able to identify the component without suffix only, so if you try to pass full name like 'StudentViewComponent' we will get runtime error notifying that no View Component identified with that name. So the verdict is to trim the suffix while calling component.

Run the application and test the results below.
Based on your requirement View Component can be called on n-number of different pages or n-number of location with on the same page. On every call, a separate instance or output gets rendered. To test let's update the Index.cshtml(HomeController view) to call component multiple times as follows.
@{
    ViewData["Title"] = "Home Page";
}

<div class="text-center">
   @await Component.InvokeAsync("Student")
   <br/>
   @await Component.InvokeAsync("Student")
   <br/>
   @await Component.InvokeAsync("Student")
</div>

View Component Returning Razor View(*.cshtml) As Result:

Using overloaded method like Microsoft.AspNetCore.Mvc.ViewComponent.View() renders the razor HTML as a View Component output.

By default framework searches for the component view path in the following areas
  • /Views/{Controller Name Folder}/Components/{View Component Name Folder}/{View Name}
  • /Views/Shared/Components/{View Component Name Folder}/{View Name}
Let's update View Component that searches for the Default.cshtml razor page in the specified path as we discussed above.
ViewComponents/StudentViewComponent.cs:
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;

namespace SampleViewComponent.App.ViewComponents
{
    public class StudentViewComponent : ViewComponent
    {
        public async Task<iviewcomponentresult> InvokeAsync()
        {
            return View();
        }
    }
}
#L10 on returning empty view from View Component, on runtime framework will automatically search for Default.cshtml as per the paths specified above.

So let's run the application and test the view component output.
On running application, we will get an error because we haven't added Default.cshtml view either in the controller or shared folder.

So let's add Default.cshtml file as below.
Views/Shared/Components/Student/Default.cshtml:
<h1>My Path: /Views/Shared/Components/Student/Default.cshtml</h1>
<h3>Hi i'm Student componen</h3>
Now run the application and view component results output as below.


Microsoft.AspNetCore.Mvc.ViewComponent.View("YourViewName") using this overloaded method we can specify view name explicitly for a view component.
ViewComponents/StudentViewComponent.cs:
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;

namespace SampleViewComponent.App.ViewComponents
{
    public class StudentViewComponent : ViewComponent
    {
        public async Task<IViewComponentResult> InvokeAsync()
        {
            return View("Student2");
        }
    }
}
#L10 at this line we passed view name explicitly.

Let's add a new view with the name specified above.
Views/Shared/Components/Student/Student2.cshml:
<h1>My Path: /Views/Shared/Components/Student/Student2.cshtml</h1>
<h3>Hi i'm Student component</h3>

Similar to the MVC controller in View Component also we can pass a model to the output view(razor view).

Let's first create a sample model that will be used by View Component.
Models/Profile.cs:
namespace SampleViewComponent.App.Models
{
    public class Profile
    {
        public string AvatarLink { get; set; }
        public string FirstName { get; set; }
        public string LastName { get; set; }
    }
}
Let's update the view component below.
ViewComponents/StudentViewComponent.cs:
using Microsoft.AspNetCore.Mvc;
using SampleViewComponent.App.Models;
using System.Threading.Tasks;

namespace SampleViewComponent.App.ViewComponents
{
    public class StudentViewComponent : ViewComponent
    {
        public async Task<IViewComponentResult> InvokeAsync()
        {
            var profile = new Profile
            {
                AvatarLink = "img/profile.webp",
                FirstName = "Naveen",
                LastName = "Bommidi"
            };
            return View("Student2",profile);
        }
    }
}
Let's update the razor view with the model binding below.
Views/Shared/Components/Student/Student2.cshml:
@model SampleViewComponent.App.Models.Profile


<div class="row">
    <div class="col-sm-4">
        <div class="card">
            <img src="@Model.AvatarLink" class="card-img-top">
            <div class="card-body">
                <h4 Card-title>@Model.FirstName @Model.LastName</h4>
            </div>
        </div>
    </div>
</div>
On running application component renders output below

Dependency Injection Support:

Similar to the MVC controller, View Component also supports Dependency Injection, where we inject all service or data access layers that can be injected into the component constructor.

An example that shows IHttpContextAccessor injects to View Components:
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;

namespace SampleViewComponent.App.ViewComponents
{
    public class StudentViewComponent : ViewComponent
    {
        private readonly IHttpContextAccessor _httpContextAccessor;
        public StudentViewComponent(IHttpContextAccessor httpContextAccessor)
        {
            _httpContextAccessor = httpContextAccessor;
        }
        public async Task<IViewComponentResult> InvokeAsync()
        {
            
            return Content("Example to show ViewComponent supports Dependency Injection")
        }
    }
}

Invoking ViewComponent From MVC Controller:

In the previous examples, we have invoked components from the *.cshtml view(Controller View), but there is an option to call or return ViewComponent as output from the MVC Controller.

Example MVC action method that returns View Component as output.
public IActionResult Index()
{
    return ViewComponent("Student2");
}

Passing Params To View Component:

On calling or invoking view component we can pass n-number of variables as below.

Example of passing values to ViewComponent
 @await Component.InvokeAsync("Student", new { id =1, firstName ="naveen", lastName ="Bommidi" })
The above variable names should be matched with input parameter names of the InvokeAsync method in View Component. If the name did not match component will ignore the input params.

Example of parameters in InvokeAsync method of View Component
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;

namespace SampleViewComponent.App.ViewComponents
{
    public class StudentViewComponent : ViewComponent
    {
        public StudentViewComponent()
        {
        }
        public async Task<IViewComponentResult> InvokeAsync(int id, string firstName, string lastName)
        {
            return Content("");
        }
    }
}

Wrapping Up:

Hopefully, I think this article delivered some useful information about View Components in .Net Core MVC or Razor Page Applications. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

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", defaults:new { …

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.Types likely to be called Grap…

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API.
When To Use Versioning:Any API response changes.Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production.Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types:Query String VersioningUrl Path VersioningMedia Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.
 Install-Package Microsoft.AspNetCore.Mvc.Versioning -version 4.0.0 Register API V…

.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 from the client, then the entire …

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: PickerControllerPickerOptions 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", "Lion", "Elephant"…

Blazor WebAssembly Dynamic Form Validation

Introduction: In Blazor WebAssembly(client-side framework) form validation can be done with Data Annotations. Using Data Annotations we can validate form either by default validation attributes or by creating custom validation attributes. Using this Data Annotation attribute we can dynamically add or remove validation on a specific field in a form.
Create Blazor WebAssembly Project: To create a Blazor WebAssembly template project need to install the latest version of VisualStudio 2019 for rich intelligence support or we can use VisualStudio code but less intelligence support from the editor. Click here to know about Blazor WebAssembly template creation. Blazor WebAssembly is in preview mode, not yet ready for production.
Create Razor Component: After creating a sample project using the Blazor WebAssembly template, in "Pages" folder add new Razor Component, name it as "UserForm.razor"
Add Route: In Blazor routing can be configured using @page  directive, and URL should b…

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 below.
PersonController.cs: us…

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism:Blazor Server is a very light-weight web development framework. In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation. Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server. Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required information or changed …

NestJS API CRUD Operations With MongoDB

Introduction: NestJS is a framework used to develop server-side applications. NestJS built on top of Node.js frameworks like Express. It is a combination of Progressive Javascript, Object-Oriented Programming, Functional Programming, and Functional Reactive Programming.
Nest CLI Installation: Using Nest CLI we are able to generate the NestJS starter project with the default template. To install Nest CLI globally over our system open command prompt and run the command
npm i -g @nestjs/cli Now create a sample project by using Nest CLI command  nest new your_project_name package.json: Now open the package.json file from the sample application created, you can observe few properties like "scripts", "dependencies", and "devDependencies".
"dependencies" contains all plugins to be installed and used them to run the application.
"devDependencies" contain all plugins to be installed and used them at the time of application development.
"scrip…

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-ControlPragmaVary 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 fresh response from serverno-store…