AppComponents.TemplateEngine 1.0.0

NuGet Package Documentation

Introduction

This library provides template rendering functionality, supporting both dictionary-based and model-based templates. It includes two main components:

1. DictionaryTemplateEngine (based on a dictionary of key-value pairs)
2. ModelTemplateEngine (based on a model object)

ReadMe

Overview

This package allows you to render templates by replacing placeholders in the template string with corresponding values from a dictionary or model. You can use it for generating dynamic content based on predefined templates.

Installation

To install the package, use the following command:

Copy code
dotnet add package AppComponents.TemplateEngine

You can also install it via the NuGet Package Manager Console:

Copy code
Install-Package AppComponents.TemplateEngine

Usage

DictionaryTemplateEngine

1. Add the package to your project.
2. Use the DictionaryTemplateEngine class to render templates from a dictionary.

Example 1: Dictionary template with implicit delimiters

var template = "Hello {name}!";
var engine = new DictionaryTemplateEngine(logger);

var values = new Dictionary<string, string> { { "name", "World" } };
var result = engine.Render(template, values);

Console.WriteLine(result); // Output: Hello World!

Example 2: Dictionary template with explicit delimiters

var template = "Hello @name!";
var engine = new DictionaryTemplateEngine(logger, "@", "");

var values = new Dictionary<string, string> { { "name", "World" } };
var result = engine.Render(template, values);

Console.WriteLine(result); // Output: Hello World!

Example 3: Dictionary template from file

var templateFile = "/Templates/templateFile.txt";
var engine = new DictionaryTemplateEngine(logger);

var values = new Dictionary<string, string> { { "name", "World" } };
var result = await engine.RenderAsync(templateFile, values);

Console.WriteLine(result); // Output: Hello World!

ModelTemplateEngine

1. Use the ModelTemplateEngine class to render templates from a model object.

Example usage:

var model = new { name = "World" };

var template = "Hello {name}!";

var engine = new ModelTemplateEngine(logger);
var result = engine.Render(template, model);

Console.WriteLine(result); // Output: Hello World!

Both classes support explicit delimiters through constructor. Both classes support asynchronous rendering with RenderAsync methods that load templates from external files.

Installation

To install the package, use the following command:

dotnet add package AppComponents.TemplateEngine

License

This project is licensed under the MIT License - see the LICENSE file for details.