View Components in ASP.NET MVC 6

Posted by Anuraj on Friday, February 6, 2015

.Net ASP.Net ASP.Net MVC

In ASP.NET MVC 6, Microsoft introduced View Components, which similar to partial views, but they are much more powerful. It is like a mini controller, which helps to render a part of response rather the whole response. View Components consists of two parts, a class, derived from ViewComponent class(Similar to POCO controllers, ViewComponent can also be POCO, it supports convention based and attribute based identifications) and a razor view which invokes the method in ViewComponent class.

A view component class can be created by:

  • Deriving from ViewComponent.
  • Decorating the class with the [ViewComponent] attribute, or deriving from a class with the [ViewComponent]attribute.
  • Creating a class where the name ends with the suffix ViewComponent.
  • Like controllers, VCs must be public, non-nested, non-abstract classes.

Creating the view component - Create a class which inherits from ViewComponent class. ViewComponent class can be anywhere in the project structure. If you are inheriting from ViewComponent class, the run time will facilitates the environment otherwise you need to inject it manually. Invoke exposes a method to be called from a view and it can take an arbitrary number of arguments. An asynchronous version, InvokeAsync, is available.

using Microsoft.AspNet.Mvc;

public class HelloWorldViewComponent: ViewComponent
{
	public IViewComponentResult Invoke()
	{
		return View(model:"Hello World");
	}
}

Creating View - In case of view, you need to follow some conventions, you need to create a folder called “Components” under Views/Home folder. This folder must be named Components. Inside that create one more folder with the ViewComponent name, in this the folder name will be “HelloWorld”. Create “Default.cshtml” inside this, with the razor markup, it’s like normal MVC view.

@model string



## @Model

In this, from View Component I am passing a string model, and I am printing it in the View.

And finally you need to include the View Component in the View. You can do it like this.

<div>
@Component.Invoke("HelloWorld") 
</div>

You can pass parameters to the Invoke method from here, you also need to change the Invoke method in the ViewComponent class as well, otherwise you will get some exceptions.

Happy Programming :)



Did you like this article? Share it with your friends

Facebook Twitter Google+ LinkedIn Reddit StumbleUpon



MVP
Subscribe


Copyright © 2017 - Anuraj P. Blog content licensed under the Creative Commons CC BY 2.5 | Unless otherwise stated or granted, code samples licensed under the MIT license. This is a personal blog. The opinions expressed here represent my own and not those of my employer. Hosted with ❤ by GitHub