What is a ViewComponent?
ViewComponent was introduced in ASP.NET Core MVC. It can do everything that a partial view can and can do even more. ViewComponents are completely self-contained objects that consistently render HTML from a razor view. ViewComponents are very powerful UI building blocks of the areas of application that are not directly accessible for controller actions. Let's suppose we have a page of social icons and we display icons dynamically. We have separate settings for color, URLs, and names of social icons and we have to render icons dynamically.
Previously this kind of thing was achieved by HtmlHelpers and child actions but now it is very easy to use ViewComponent for this purpose. It is very easy to create your dynamic elements in a ViewCompnent and render them in a view.
Creating a ViewComponent
Step 1. Create a new ASP.NET Core MVC application and run that application. You can see an empty page like the following.
Step 2. We have to display data dynamically. In real scenarios, dynamic data mostly comes from the database but for our application, we do not use a database and we will create a class to generate more data. So let's create a class. Add a class with the name SocialIcon and add the following fields and methods to it.
public class SocialIcon
{
public int ID { get; set; }
public string IconName { get; set; }
public string IconBgColor { get; set; }
public string IconTargetUrl { get; set; }
public string IconClass { get; set; }
public static List<SocialIcon> AppSocialIcons()
{
List<SocialIcon> icons = new List<SocialIcon>();
icons.Add(new SocialIcon { ID = 1, IconName = "Google", IconBgColor = "#dd4b39", IconTargetUrl = "www.google.com", IconClass = "fa fa-google" });
icons.Add(new SocialIcon { ID = 2, IconName = "Facebook", IconBgColor = "#3B5998", IconTargetUrl = "www.facebook.com", IconClass = "fa fa-facebook" });
icons.Add(new SocialIcon { ID = 3, IconName = "Linked In", IconBgColor = "#007bb5", IconTargetUrl = "www.linkedin.com", IconClass = "fa fa-fa-linkedin" });
icons.Add(new SocialIcon { ID = 4, IconName = "YouTube", IconBgColor = "#007bb5", IconTargetUrl = "www.youtube.com", IconClass = "fa fa-youtube" });
icons.Add(new SocialIcon { ID = 5, IconName = "Twitter", IconBgColor = "#55acee", IconTargetUrl = "www.twitter.com", IconClass = "fa fa-twitter" });
return icons;
}
}
Step 3. Add a ViewComponent class with the name SocialLinksViewComponent. (Don't forget to add ViewComponent with its name, in our application, we will use it with the name SocialLinks, and by writing ViewComponent with its name system will understand that it is ViewComponent and will be handled accordingly).
Step 4.ViewComponents are generated from a C# class derived from a base class ViewComponent and are typically associated with Razor files to generate markup. Just like controllers, ViewComponents also supports constructor injection. To implement SocialLinksViewComponent add the following code in your class that you have just created.
public class SocialLinksViewComponent : ViewComponent
{
List<SocialIcon> socialIcons = new List<SocialIcon>();
public SocialLinksViewComponent()
{
socialIcons = SocialIcon.AppSocialIcons();
}
public async Task<IViewComponentResult> InvokeAsync()
{
var model = socialIcons;
return await Task.FromResult((IViewComponentResult)View("SocialLinks", model));
}
}
We created a class and added a List of SocialIcon class. In the constructor, we loaded our list with data (it is not mandatory to add in the constructor you can add data in the InvokeAsync method as well and there will be no need for a constructor). It will return data in our model object and will render markup in Razor View SocialLinks.
Step 5. We added a folder in Views > Shared with the name Components (it should have Components name). And will add a folder SocialLinks in this folder we created a Razor View with the name SocialLinks.cshtml. Do the same and add the following code in Razor View.
@model IList<ViewComponentApp.Models.SocialIcon>
<p class="col-md-12" style="padding-top:50px;">
@foreach (var icon in Model)
{
<a style="background:@icon.IconBgColor" href="@icon.IconTargetUrl">
<i class="@icon.IconClass"></i>
@icon.IconName
</a>
}
</p>
Step 6. Now we have implemented our ViewComponent and added markup HTML in our corresponding Razor View. Now we will call this ViewComponent in our desired page where it is needed. I am calling it on Index.cshtml page you can use it anywhere in the application with just the following code.
@(await Component.InvokeAsync("SocialLinks"))
This above code snippet is the way we can call a ViewComponent in our Razor Views. It will render the desired markup. You can also pass parameters in ViewComponents as follows.
@(await Component.InvokeAsync("SocialLinks", new { IconsToShow = 5 }))
This is how we can pass parameters. But in our application, we are not passing any parameters so we will use the snippet above. So code in our Index.CSS HTML page will look like this.
@{
ViewData["Title"] = "Home Page";
}
<style>
a {
padding: 5px;
margin: 5px;
color: white;
}
.main-p {
margin-bottom: 20px;
padding-bottom: 20px;
}
</style>
<p class="text-center main-p">
<h1 class="display-4">Welcome</h1>
<h3>View Component Example</h3>
@(await Component.InvokeAsync("SocialLinks", new { IconsToShow = 5 }))
</p>
Step 7. Run the application. After successfully running the application you will see the following output.
You can see that our ViewComponent is rendered on our Index.cshtml page. Similarly, this can be rendered on any page in the application using the same call that we used on Index.cshtml page.
Happy Coding!
IMAD AYOUBPosted Aug 22, 2021, 11:28 AM
Excellent tutorial. Very useful. Thanks a lot.
Andre SilveiraPosted Jul 6, 2021, 6:23 PM
I tryied to implement calling the data from database, but I'm getting a error. It says that a IList is expected but instead the model sends a List.... I can't figure out what's wrong. Is there any tutorial using a database to fill the data?
Rajesh ThampiPosted Jun 13, 2021, 6:36 AM
Excellent article Jamil Moughal, I had kind of difficulty understanding how to call the view component from my layout view (Like in a master page). Thank you very much for the sample solution.
tom doninoPosted Oct 26, 2020, 7:42 PM
And how can that be used in the layout page, in a footer for example, which is on every page? The model in the view component conflicts with content pages view model and errors occur. I've spent hours on this issue and can't find a solution where a VC works, with a data model, on every page in an application.
U ThuPosted Dec 28, 2019, 10:36 AM
Good article.Please share for asp.net core razor with singleR real time notification button counter(Facebook bell) tutorials.I can not see this post.
Sourav Kumar DasPosted Dec 26, 2019, 12:47 AM
Nice and useful article. Thanks for sharing.
Chittaranjan SwainPosted Dec 23, 2019, 10:53 PM
Nice article.