requirejs-twig

1.0.4 • Public • Published

Require.js Twig Plugin

Installation

Use bower or npm to add requirejs-twig plugin to your project:

bower install requirejs-twig

or

npm install requirejs-twig

Config

Make sure you tell requirejs about new twigjs plugin by editing your requirejs config file. In addition? you can redefine several options.

require.config({
    paths: {
        twig: 'path/to/libs/twig.js/twig',
        twigjs: 'path/to/libs/require-twig/twigjs'
    },
    // optional
    config: {
        twigjs: {
            autoescape: false, // default: true (Since Twig.js 0.8.0)
            extension: 'html' // default: twig
        }
    }
});

Usage

Write a template (path: templates/profile.twig):

<a href="{{ profileUrl }}">
    <img src="{{ avatarUrl }}" alt="" class="avatar">
</a>
<h1 class="names">
    <span class="fullname">{{ firstName }} {{ lastName }}</span>
    <span class="username">{{ userName }}</span>
</h1>

Then require your template like so:

require(['twigjs!templates/profile'], function(template) {
    document.body.innerHTML = template({
        avatarUrl: 'http://avatars.example.com/users/jdoe?v=1',
        profileUrl: 'http://example.com/jdoe',
        userName: 'jdoe',
        firstName: 'John',
        lastName: 'Doe'
    });
});

And the output into document's body would be as follows:

<a href="http://example.com/jdoe">
    <img src="http://avatars.example.com/users/jdoe?v=1" alt="" class="avatar">
</a>
<h1 class="names">
    <span class="fullname">John Doe</span>
    <span class="username">jdoe</span>
</h1>

Usage with Backbone/Marionette

define(['twigjs!templates/profile'], function(template) {
    return Marionette.ItemView.extend({
        template: template
    });
});

Package Sidebar

Install

npm i requirejs-twig

Weekly Downloads

0

Version

1.0.4

License

MIT

Last publish

Collaborators

  • dyurkavets