We're OGS, check out our work on github.com/ogs-gmbh

ngx-template-engine

A flexible and efficient template engine for dynamic content rendering. It enables easy integration of customizable templates within Angular applications.

Getting Started

[!IMPORTANT] We're offering an extensive API-Reference covered with in-depth usage examples of this project.

To get a starting point, simply refer to our documentation at ogs-gmbh.github.io/ngx-template-engine.

Prerequisites

• Node.js version 18 or higher.
• A package manager: e.g. npm, pnpm, ...

Installation

Using npm:

$ npm install @ogs-gmbh/ngx-template-engine

Using yarn:

$ pnpm add @ogs-gmbh/ngx-template-engine

Using pnpm:

$ pnpm add @ogs-gmbh/ngx-template-engine

Using bun:

$ bun add @ogs-gmbh/ngx-template-engine

Usage

Each piped value requires either a DataArray or DataRecord for getting the template engine to work.

As an example, we define an DataRecord inside our app.component.ts:

import { Component } from "@angular/common";
import { TemplatePipe } from "@ogs-gmbh/ngx-template-engine";

@Component({
  imports: [
    TemplatePipe
  ],
  templateUrl: "./app.component.html"
})
export class AppComponent {
  user = {
    name: "World"
  };
}

Now, you can use the DataRecord inside your pipe:

<p>{{ "Hello {name}" | template : user }}</p>

The Paragraph-Element should now contain Hello World as TextNode.

License

The MIT License (MIT) - Please have a look at the LICENSE file for more details.

Contributing

Contributions are always welcome and greatly appreciated. Whether you want to report a bug, suggest a new feature, or improve the documentation, your input helps make the project better for everyone.

Feel free to submit a pull request, issue or feature request.

Issues and Feature Requests

Reporting an issue or creating a feature request is made by creating a new issue on this repository.

You can create a new issue or feature request here.

Pull Requests

GitHub offers a solid guideline for contributing to open source projects through pull requests, covering key practices. These best practices provide a reliable starting point for making effective contributions.

You can find the guidelines here.

Code Of Conduct

We are committed to keeping a welcoming, inclusive, and respectful community for everyone. To help us achieve this, we kindly ask that you adhere to our Code of Conduct.

Disclaimer

All trademarks and registered trademarks mentioned are property of their respective owners and are used for identification purposes only. Use of these names does not imply endorsement or affiliation.

This project is a trademark of OGS Gesellschaft für Datenverarbeitung und Systemberatung mbH. The License does not grant rights to use the trademark without permission.

Imprint | Contact | Careers