@veams/plugin-templater

Veams Templater Plugin (@veams/plugin-templater)

This plugin adds the possibility to render your handlebars templates in an easy way. You can register the engine, templates, partials and helpers and use them directly in other classes.

TypeScript is supported.

---

Installation

NPM

npm install @veams/plugin-templater --save

Yarn

yarn add @veams/plugin-templater

---

Usage

import Veams from '@veams/core';
import TemplaterPlugin from '@veams/plugin-templater';
import handlebars from 'handlebars/runtime';
import { templates } from './templates';
import { customHelper } from './helpers';

// Intialize core of Veams
Veams.onInitialize(() => {
   	// Add plugins to the Veams system
	
    // Add plugins to the Veams system
    Veams.use(TemplaterPlugin, {
        engine: handlebars,
        templates: templates,
        helpers: [
            customHelper
        ]
    });
});

Options

Option	Type	Default	Description
engine	{Function}	[null]	Provide the handlebars engine instance.
templates	{Function}	[null]	Provide your precompiled handlebars templates.
partials	{Function}	[null]	You can provide additional partials.
helpers	{Array}	[[]]	Add custom handlebars helpers.

API

When enabled you can render your template by simple executing the Veams.templater.render():

// Render the template
$(body).append(
    Veams.templater.render('test-template', {data: 'custom data passed to partial'})
);