ASP.NET Core MVC

Create ViewComponent in ASP.NET Core MVC


Create ASP.NET Core MVC Project

On the Visual Studio, create new ASP.NET Core MVC Web Application project

Select Empty Template

Click Ok button to Finish




Add Configurations

Open Startup.cs file and add new configurations as below:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;

namespace LearnASPNETCoreMVCWithRealApps
{
    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc();
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseStaticFiles();

            app.UseMvc(routes =>
            {
                routes.MapRoute(
                    name: "default",
                    template: "{controller=Home}/{action=Index}/{id?}");
            });

        }
    }
}

Create ViewComponent

Create Class for ViewComponent

Create new folder named ViewComponents. In this folder, create new class named CategoryViewComponent.cs as below:

using Microsoft.AspNetCore.Mvc;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace LearnASPNETCoreMVCWithRealApps.ViewComponents
{
    [ViewComponent(Name = "Category")]
    public class CategoryViewComponent : ViewComponent
    {
        public async Task<IViewComponentResult> InvokeAsync()
        {
            List<string> categories = new List<string>() {
                "Category 1", "Category 2", "Category 3", "Category 4", "Category 5"
            };
            return View("Index", categories);
        }

    }
}

Create View for ViewComponent

Create new folder named Views. In Views folder, create new folders with path Views\Shared\Components\Category. In Category folder, create new file named Index.cshtml:

<h3>Categories List</h3>
<ul>
    @foreach (var category in Model)
    {
        <li>@category</li>
    }
</ul>




Create Layout Page

In Views folder, create new folder named Shared. In this folder, create Razor Layout named _MasterLayoutPage.cshtml as below:

<!DOCTYPE html>

<html>
<head>
    <meta name="viewport" content="width=device-width" />
    <title>@ViewBag.Title</title>
</head>
<body>

    <table border="1" cellpadding="2" cellspacing="2" width="500">
        <tr>
            <td colspan="2">
                <a asp-controller="home" asp-action="index">Home</a> |
                <a asp-controller="aboutus" asp-action="index">About Us</a> |
                <a asp-controller="news" asp-action="index">News</a>
            </td>
        </tr>
        <tr>
            <td valign="top">
                @await Component.InvokeAsync("Category")
            </td>
            <td valign="top">
                @RenderBody()
            </td>
        </tr>
        <tr>
            <td colspan="2">Copyright PMK Lab</td>
        </tr>
    </table>

</body>
</html>

Create Controller

In Controllers folder, create new controllers as below:

Home Controller

Create new controller named HomeController.cs as below:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;

namespace LearnASPNETCoreMVCWithRealApps.Controllers
{
    [Route("home")]
    public class HomeController : Controller
    {
        [Route("")]
        [Route("index")]
        [Route("~/")]
        public IActionResult Index()
        {
            return View();
        }
    }
}

AboutUs Controller

Create new controller named AboutUsController.cs as below:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;

namespace LearnASPNETCoreMVCWithRealApps.Controllers
{
    [Route("aboutus")]
    public class AboutUsController : Controller
    {
        [Route("index")]
        public IActionResult Index()
        {
            return View();
        }

    }
}

News Controller

Create new controller named NewsController.cs as below:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;

namespace LearnASPNETCoreMVCWithRealApps.Controllers
{
    [Route("news")]
    public class NewsController : Controller
    {
        [Route("index")]
        public IActionResult Index()
        {
            return View();
        }

    }
}




Create View

In Views folder, create new razor views as below:

Home Views

In Views/Home folder, create new view named Index.cshtml as below:

@{
    Layout = "~/Views/Shared/_MasterLayoutPage.cshtml";
}

<h2>Home Page</h2>

AboutUs Views

In Views/AboutUs folder, create new view named Index.cshtml as below:

@{
    Layout = "~/Views/Shared/_MasterLayoutPage.cshtml";
}

<h2>About Us Page</h2>

News Views

In Views/News folder, create new view named Index.cshtml as below:

@{
    Layout = "~/Views/Shared/_MasterLayoutPage.cshtml";
}

<h2>News Page</h2>

Structure of ASP.NET MVC Project




Run Application

Access Index action in Home controller with following url: http://localhost:49328

Output

Access Index action in AboutUs controller with following url: http://localhost:49328/AboutUs/Index

Output

Access Index action in News controller with following url: http://localhost:49328/News/Index

Output

References

I recommend you refer to the books below to learn more about the knowledge in this article:


Related Posts

Custom DateTime Format in ASP.NET Core MVC 5

Globalization and Localization in ASP.NET Core MVC 5

Send Email with Attachment in ASP.NET Core MVC 5