Razor.Templating.Core 1.8.0

.NET 6.0
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Razor.Templating.Core --version 1.8.0
NuGet\Install-Package Razor.Templating.Core -Version 1.8.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Razor.Templating.Core" Version="1.8.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Razor.Templating.Core --version 1.8.0
#r "nuget: Razor.Templating.Core, 1.8.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Razor.Templating.Core as a Cake Addin
#addin nuget:?package=Razor.Templating.Core&version=1.8.0

// Install Razor.Templating.Core as a Cake Tool
#tool nuget:?package=Razor.Templating.Core&version=1.8.0

<img src="https://raw.githubusercontent.com/soundaranbu/RazorTemplating/master/src/Razor.Templating.Core/assets/icon.png" width="70" height="70" />

Razor.Templating.Core

Build+Test Nuget Downloads Coverage

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 1.8.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
@Url.ContentUrl**
@Url.RouteUrl**

**Contributors are welcome who can help to enable these unsupported features.

Applications

  • Email Templating
  • Report Generation & more

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.8.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 sample implementation: https://medium.com/@soundaranbu/render-razor-view-cshtml-to-string-in-net-core-7d125f32c79

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

The Razor Class Library's .csproj file should look something like below. Whereas, AddRazorSupportForMvc property is important.

Also, RCL should be referenced to the main project or where the RazorTemplateEngine.RenderAsync method is invoked.

<Project Sdk="Microsoft.NET.Sdk.Razor">
  <PropertyGroup>
    <TargetFrameworks>net6.0</TargetFrameworks>
    <AddRazorSupportForMvc>true</AddRazorSupportForMvc>
  </PropertyGroup>

  <ItemGroup>
    <FrameworkReference Include="Microsoft.AspNetCore.App" />
  </ItemGroup>
</Project>

Dependency Injection

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(); 

Once the dependencies are registered, we can use either one of these ways:

Using RazorTemplateEngine static class
var html = await RazorTemplateEngine.RenderAsync("~/Views/ExampleViewServiceInjection.cshtml");
Using IRazorTemplateEngine
  • Instead of using the RazorTemplateEngine static class, it's also possible to use the IRazorTemplateEngine interface to inject dependency directly into the constructor.
public class MyService {
    private readonly IRazorTemplateEngine _razorTemplateEngine;

    public MyService (IRazorTemplateEngine razorTemplateEngine)
    {
        _razorTemplateEngine = razorTemplateEngine;
    }

    public async Task Index()
    {
        var renderedView = await _razorTemplateEngine.RenderAsync("/Views/Home/Index.cshtml");
        // do something with renderedView
    }
}

How to render razor views from absolute path

We can make use of ASP.NET Core's inbuilt RazorRuntimeCompilation to render any .cshtml inside or outside of the project.

As of v1.7.0+, we can achieve this as below:

using Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.FileProviders;
using Razor.Templating.Core;

var services = new ServiceCollection();
services.AddMvcCore().AddRazorRuntimeCompilation();
services.Configure<MvcRazorRuntimeCompilationOptions>(opts =>
{
    opts.FileProviders.Add(new PhysicalFileProvider(@"D:\PathToRazorViews")); // This will be the root path
});
services.AddRazorTemplating();

var html = await RazorTemplateEngine.RenderAsync("/Views/Home/Rcl.cshtml"); // relative path to the root

Please note this may become slightly better in the future versions of our library.

Sample Applications

Please find the sample applications here

Support

If you find this helpful, consider supporting the development of this library by sponsoring one or more coffee ;) Thanks!

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!

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.

NuGet packages (10)

Showing the top 5 NuGet packages that depend on Razor.Templating.Core:

Package Downloads
Sitko.Core.App.Web

Sitko.Core is a set of libraries to help build .NET Core applications fast

FenixAlliance.ACL.Dependencies

Application Component for the Alliance Business Suite.

Unlog.AspNetCore

the aspnetcore package for UnLog

FinancialModuleAuxiliary

Package Description

Digizuite.Optimizely

The official integration between Digizuite DAM and Optimizely CMS.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.9.0-rc.1 130 11/13/2022
1.8.0 6,746 11/5/2022
1.8.0-rc.1 2,379 9/17/2022
1.7.1 147,293 7/2/2022
1.7.1-rc.1 5,561 2/20/2022
1.7.0 330,252 11/13/2021
1.7.0-preview.1 2,117 9/26/2021
1.6.1-rc.1 1,479 1/13/2022
1.6.0 190,860 9/26/2021
1.6.0-rc.2 5,306 5/14/2021
1.6.0-rc.1 421 5/13/2021
1.5.0 236,430 2/27/2021
1.4.0 60,153 12/5/2020
1.4.0-rc.1 565 11/19/2020
1.3.0 7,858 11/17/2020
1.2.1 23,529 9/21/2020
1.2.0 3,299 7/11/2020
1.1.2 1,398 4/13/2020
1.1.0 435 4/13/2020
1.0.1 677 4/3/2020
1.0.0 612 4/3/2020

- Added IRazorTemplateEngine interface that can be used for constructor dependency injection instead of using a static class.