Plinth.Templating
1.6.6
Prefix Reserved
See the version list below for details.
dotnet add package Plinth.Templating --version 1.6.6
NuGet\Install-Package Plinth.Templating -Version 1.6.6
<PackageReference Include="Plinth.Templating" Version="1.6.6" />
paket add Plinth.Templating --version 1.6.6
#r "nuget: Plinth.Templating, 1.6.6"
// Install Plinth.Templating as a Cake Addin #addin nuget:?package=Plinth.Templating&version=1.6.6 // Install Plinth.Templating as a Cake Tool #tool nuget:?package=Plinth.Templating&version=1.6.6
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 | Versions 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 was computed. 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 is compatible. 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. |
-
net6.0
- Microsoft.SourceLink.Bitbucket.Git (>= 1.1.1)
- Plinth.Common (>= 1.6.6)
- RazorLight (>= 2.3.1)
- System.Text.Json (>= 8.0.5)
-
net8.0
- Microsoft.SourceLink.Bitbucket.Git (>= 1.1.1)
- Plinth.Common (>= 1.6.6)
- RazorLight (>= 2.3.1)
- System.Text.Json (>= 8.0.5)
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.1 | 129 | a month ago |
1.7.0 | 147 | 2 months ago |
1.6.6 | 360 | 2 months ago |
1.6.5 | 889 | 4 months ago |
1.6.4 | 479 | 5 months ago |
1.6.3 | 595 | 8 months ago |
1.6.2 | 365 | 2/16/2024 |
1.6.1 | 3,903 | 1/5/2024 |
1.6.0 | 1,164 | 11/30/2023 |
1.5.10-b186.aca976b4 | 98 | 11/30/2023 |
1.5.9 | 166 | 11/29/2023 |
1.5.9-b174.64153841 | 239 | 11/23/2023 |
1.5.9-b172.dfc6e7bd | 208 | 11/17/2023 |
1.5.9-b171.4e2b92e2 | 376 | 11/4/2023 |
1.5.8 | 460 | 10/23/2023 |
1.5.7 | 5,486 | 7/31/2023 |
1.5.6 | 1,698 | 7/13/2023 |
1.5.5 | 201 | 6/29/2023 |
1.5.4 | 994 | 3/7/2023 |
1.5.3 | 267 | 3/3/2023 |
1.5.2 | 371 | 1/11/2023 |
1.5.2-b92.7c961f5f | 125 | 1/11/2023 |
1.5.0 | 537 | 11/9/2022 |
1.5.0-b88.7a7c20cd | 114 | 11/9/2022 |
1.4.7 | 2,319 | 10/20/2022 |
1.4.6 | 625 | 10/17/2022 |
1.4.5 | 641 | 10/1/2022 |
1.4.4 | 491 | 8/16/2022 |
1.4.3 | 455 | 8/2/2022 |
1.4.2 | 453 | 7/19/2022 |
1.4.2-b80.7fdbfd04 | 146 | 7/19/2022 |
1.4.2-b74.acaf86f5 | 132 | 6/15/2022 |
1.4.1 | 470 | 6/13/2022 |
1.4.0 | 447 | 6/6/2022 |
1.3.8 | 861 | 4/12/2022 |
1.3.7 | 509 | 3/21/2022 |
1.3.6 | 496 | 3/17/2022 |
1.3.6-b67.ca5053f3 | 143 | 3/16/2022 |
1.3.6-b66.4a9683e6 | 144 | 3/16/2022 |
1.3.5 | 483 | 2/23/2022 |
1.3.4 | 786 | 1/20/2022 |
1.3.3 | 362 | 12/29/2021 |
1.3.2 | 480 | 12/11/2021 |
1.3.1 | 391 | 11/12/2021 |
1.3.0 | 344 | 11/8/2021 |
1.2.3 | 1,538 | 9/22/2021 |
1.2.2 | 739 | 8/20/2021 |
1.2.1 | 744 | 8/5/2021 |
1.2.0 | 502 | 8/1/2021 |
1.2.0-b37.a54030b9 | 168 | 6/24/2021 |
1.1.6 | 1,842 | 3/22/2021 |
1.1.5 | 388 | 3/9/2021 |
1.1.4 | 514 | 2/27/2021 |
1.1.3 | 414 | 2/17/2021 |
1.1.2 | 383 | 2/12/2021 |
1.1.1 | 724 | 2/1/2021 |
1.1.0 | 518 | 12/16/2020 |
1.1.0-b27.b66c309b | 295 | 11/15/2020 |
1.0.12 | 1,115 | 10/18/2020 |
1.0.11 | 506 | 10/6/2020 |
1.0.10 | 468 | 9/30/2020 |
1.0.9 | 461 | 9/29/2020 |
1.0.8 | 673 | 9/26/2020 |
1.0.7 | 615 | 9/19/2020 |
1.0.6 | 506 | 9/3/2020 |
1.0.5 | 799 | 9/2/2020 |
1.0.4 | 701 | 9/1/2020 |
1.0.3 | 548 | 9/1/2020 |
1.0.2 | 557 | 8/29/2020 |
1.0.1 | 554 | 8/29/2020 |
1.0.0 | 532 | 8/29/2020 |
1.0.0-b1.c22f563d | 251 | 8/28/2020 |
net8.0 support