Plinth.Templating 1.5.2-b92.7c961f5f

Prefix Reserved
This is a prerelease version of Plinth.Templating.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Plinth.Templating --version 1.5.2-b92.7c961f5f
                    
NuGet\Install-Package Plinth.Templating -Version 1.5.2-b92.7c961f5f
                    
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="Plinth.Templating" Version="1.5.2-b92.7c961f5f" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Plinth.Templating" Version="1.5.2-b92.7c961f5f" />
                    
Directory.Packages.props
<PackageReference Include="Plinth.Templating" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Plinth.Templating --version 1.5.2-b92.7c961f5f
                    
#r "nuget: Plinth.Templating, 1.5.2-b92.7c961f5f"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=Plinth.Templating&version=1.5.2-b92.7c961f5f&prerelease
                    
Install Plinth.Templating as a Cake Addin
#tool nuget:?package=Plinth.Templating&version=1.5.2-b92.7c961f5f&prerelease
                    
Install Plinth.Templating as a Cake Tool

README

Plinth.Templating

HTML Templating library for generating emails and documents

1. Create an assembly with your cshtml templates in it, and some models

Directory structure example for a template assembly:

Templates/
	Email1.cshtml
	Email2.cshtml
	Email3.cshtml
Layouts/
	DefaultEmail.cshtml
Shared/
	ButtonLink.cshtml
Models/
	EmailModel.cs

2. Initialize the engine

    var engine = new TemplateEngineBuilder()
        .AddTemplateAssembly(typeof(EmailModel).Assembly, new[] { "Layouts", "Shared", "Templates" })
        .PrecompileInBackground() // optional
        .Build();

👉 the paths given are optional. If none are given then you must specify the full path from the assembly root         Example, with no paths, specify "Templates/Email1"         with "Templates" specified, "Email1" will work as well 👉 This goes for references in your code to templates, as well as Layouts, Partials, and IncludeAsync's 👉 The root of the assembly is always included

3. Set up templates

⚠️ NOTE! NOTE! NOTE! 👉 Make sure your cshtml files are set to "Embedded Resource" in your .csproj

@using MyAssembly.Models							// using directives work just like c#

@inherits Plinth.Templating.Template<EmailModel>    // do this to enable Include functionality
@inherits Plinth.Templating.Template		        // if not using a model

@model EmailModel									// set up your model

@{ Layout = "DefaultEmail"; }						// optionally, set up a Layout

@{ await IncludeAsync("ButtonLink", Model.Link); }	// example of including another template

<p>@Model.Title</p>									// example of using the model
<p>@ViewBag.Subtitle</p>							// example of using the view bag

@functions {										// static functions
    public static int Double(int x) => x * 2;
}

@{													// local functions (can access model and viewbag)
    int Double() => Model.Number * 2;
}

4. Render your templates

// no model
var result = await engine.RenderAsync("Email1");

// with model
var emailModel = new EmailModel { ... }
var result = await engine.RenderAsync("Email1", emailModel);

// with viewbag
dynamic viewbag = new ExpandoObject();
viewbag.Field1 = 7;
var result = await engine.RenderWithViewBagAsync("Email1", viewbag);

// with model and viewbag
var emailModel = new EmailModel { ... }
dynamic viewbag = new ExpandoObject();
viewbag.Field1 = 7;
var result = await engine.RenderWithViewBagAsync("Email1", emailModel, viewbag);

5. Rendering dynamic templates from strings

You can render a string template and cache it for later use, or for one time use

👉 These following are cached by "TemplateKey1", and re-rendering with that same key will ignore the string template subsequent renders

// no model
var result = await engine.RenderRawAsync("TemplateKey1", "<div>Hello</div>");

// with model
var emailModel = new EmailModel { ... }
var result = await engine.RenderRawAsync("TemplateKey1", 
	"<div>@Model.Name</div>", emailModel);

// with viewbag
dynamic viewbag = new ExpandoObject();
viewbag.Field1 = 7;
var result = await engine.RenderRawWithViewBagAsync("TemplateKey1",
	"<div>@ViewBag.Field1</div>", viewbag);

// with model and viewbag
var emailModel = new EmailModel { ... }
dynamic viewbag = new ExpandoObject();
viewbag.Field1 = 7;
var result = await engine.RenderRawWithViewBagAsync("TemplateKey1", 
	"<div>@Model.Name, @ViewBag.Field1</div>", emailModel, viewbag);

👉 The following are one-offs and will re-compile every time

// no model
var result = await engine.RenderRawOnceAsync("<div>Hello</div>");

// with model
var emailModel = new EmailModel { ... }
var result = await engine.RenderRawOnceAsync("<div>@Model.Name</div>", emailModel);

// with viewbag
dynamic viewbag = new ExpandoObject();
viewbag.Field1 = 7;
var result = await engine.RenderRawOnceWithViewBagAsync(
	"<div>@ViewBag.Field1</div>", viewbag);

// with model and viewbag
var emailModel = new EmailModel { ... }
dynamic viewbag = new ExpandoObject();
viewbag.Field1 = 7;
var result = await engine.RenderRawOnceWithViewBagAsync( 
	"<div>@Model.Name, @ViewBag.Field1</div>", emailModel, viewbag);
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.7.2 352 3/16/2025
1.7.1 464 12/12/2024
1.7.0 222 11/12/2024
1.6.6 679 11/8/2024
1.6.5 1,970 8/31/2024
1.6.4 496 8/2/2024
1.6.3 609 5/15/2024
1.6.2 380 2/16/2024
1.6.1 4,356 1/5/2024
1.6.0 1,169 11/30/2023
1.5.10-b186.aca976b4 103 11/30/2023
1.5.9 171 11/29/2023
1.5.9-b174.64153841 243 11/23/2023
1.5.9-b172.dfc6e7bd 212 11/17/2023
1.5.9-b171.4e2b92e2 381 11/4/2023
1.5.8 466 10/23/2023
1.5.7 7,391 7/31/2023
1.5.6 1,708 7/13/2023
1.5.5 218 6/29/2023
1.5.4 1,011 3/7/2023
1.5.3 286 3/3/2023
1.5.2 392 1/11/2023
1.5.2-b92.7c961f5f 143 1/11/2023
1.5.0 557 11/9/2022
1.5.0-b88.7a7c20cd 132 11/9/2022
1.4.7 2,343 10/20/2022
1.4.6 647 10/17/2022
1.4.5 664 10/1/2022
1.4.4 513 8/16/2022
1.4.3 479 8/2/2022
1.4.2 478 7/19/2022
1.4.2-b80.7fdbfd04 169 7/19/2022
1.4.2-b74.acaf86f5 156 6/15/2022
1.4.1 493 6/13/2022
1.4.0 477 6/6/2022
1.3.8 891 4/12/2022
1.3.7 545 3/21/2022
1.3.6 527 3/17/2022
1.3.6-b67.ca5053f3 172 3/16/2022
1.3.6-b66.4a9683e6 173 3/16/2022
1.3.5 514 2/23/2022
1.3.4 818 1/20/2022
1.3.3 397 12/29/2021
1.3.2 511 12/11/2021
1.3.1 425 11/12/2021
1.3.0 377 11/8/2021
1.2.3 1,571 9/22/2021
1.2.2 773 8/20/2021
1.2.1 776 8/5/2021
1.2.0 541 8/1/2021
1.2.0-b37.a54030b9 200 6/24/2021
1.1.6 1,884 3/22/2021
1.1.5 429 3/9/2021
1.1.4 555 2/27/2021
1.1.3 454 2/17/2021
1.1.2 424 2/12/2021
1.1.1 764 2/1/2021
1.1.0 561 12/16/2020
1.1.0-b27.b66c309b 336 11/15/2020
1.0.12 1,231 10/18/2020
1.0.11 553 10/6/2020
1.0.10 509 9/30/2020
1.0.9 503 9/29/2020
1.0.8 719 9/26/2020
1.0.7 658 9/19/2020
1.0.6 547 9/3/2020
1.0.5 841 9/2/2020
1.0.4 744 9/1/2020
1.0.3 589 9/1/2020
1.0.2 602 8/29/2020
1.0.1 596 8/29/2020
1.0.0 573 8/29/2020
1.0.0-b1.c22f563d 292 8/28/2020

net7.0 support and removed netcoreapp3.1