dirvo / RazorTemplating

Razor Templating Engine to render Razor Views(.cshtml files) to String in Console, Web, Service, Desktop workloads in .NET Core 3+

Razor Templating

Using Razor for HTML templating was never been so easy like this. Render your .cshtml files into string easily using this library.

This project makes use of Razor SDK for precompiling the views.

Supported Application Types

	.NET Core 3.0	.NET Core 3.1	.NET 5	.NET 6
Preferred Version	v1.6.0	v1.6.0	v1.6.0	v1.7.0
Console	✓	✓	✓	✓
Api	✓	✓	✓	✓
Mvc	✓	✓	✓	✓
Worker Service	✓	✓	✓	✓
WPF	✓	✓	✓	✓
WinForms	✓	✓	✓	✓
Azure Functions	✓	✓	✓	✓

Supported View Features

MVC Razor View Features
ViewModel	✓
ViewBag	✓
ViewData	✓
Layouts	✓
ViewStarts	✓
ViewImports	✓
Partial Views	✓
Tag Helpers	✓
View Components (.NET 5 +)	✓
Dependency Injection into Views	✓

Applications

• Email Templating
• Report Generation & so on

Installing Nuget Package

This library is available as Nuget package

Using .NET CLI

dotnet add package Razor.Templating.Core

Using Package Reference .csproj

<PackageReference Include="Razor.Templating.Core" Version="1.7.0" />

Simple Usage:

using Razor.Templating.Core;

var model = new ExampleModel()
{
    PlainText = "This text is rendered from Razor Views using Razor.Templating.Core",
    HtmlContent = "<em>You can use it to generate email content, report generation and so on</em>"
};

// Both ViewBag and ViewData should be added to the same dictionary. 
var viewDataOrViewBag = new Dictionary<string, object>();
// ViewData is same as mvc
viewDataOrViewBag["Value1"] = "1";

// ViewBag.Value2 can be written as below. There's no change on how it's accessed in .cshtml file
viewDataOrViewBag["Value2"] = "2";

var html = await RazorTemplateEngine.RenderAsync("/Views/ExampleView.cshtml", model, viewDataOrViewBag);

Before applying this code, follow this article for working implementation: https://medium.com/@soundaranbu/render-razor-view-cshtml-to-string-in-net-core-7d125f32c79

Dependency Injection [Since v1.4.0]

Dependencies can be injected directly into views using @inject in .csthml file. Refer sample application here

In ASP.NET Core, add dependency like below in Startup.cs -> ConfigureServices

...
services.AddTransient<ExampleService>();
//add after registering all the dependencies
services.AddRazorTemplating();

or in console or other applications, add as below

using Microsoft.Extensions.DependencyInjection;

// Add dependencies to the service collection
var services = new ServiceCollection();
services.AddTransient<ExampleService>();
// Add RazorTemplating after registering all dependencies
// this is important for the razor template engine to find the injected services
services.AddRazorTemplating(); 
var html = await RazorTemplateEngine.RenderAsync("~/Views/ExampleViewServiceInjection.cshtml");

Razor Views in Library

Razor view files(.cshtml) can be organized in a separate shared Razor Class Libary(RCL). Sample library can be found here

Sample Applications

Please find the sample applications here

Note:

• Please ensure that the views path is always unique among all the shared template projects.

References:

Thanks to all the great articles and projects which helped to bring this library out!

• https://github.com/Andy9FromSpace/razor-renderer-core
• https://github.com/aspnet/Entropy/tree/master/samples/Mvc.RenderViewToString
• https://www.frakkingsweet.com/razor-template-rendering/
• https://github.com/veccsolutions/RenderRazorConsole
• https://emilol.com/razor-mailer/
• https://codeopinion.com/using-razor-in-a-console-application/