twig.js

twig.js is a flexible, secure, and high-performance templating engine for Javascript.

It compiles your Twig templates to raw Javascript allowing you to use the same templates for both server-, and client-side.

{# greeting.twig #}
{% twig_js name="greeting" %}
Hello {{ name|default("World") }}!

Note the twig_js tag above is a compile-time directive which allows you to set the name of the compiled Javascript function. You can omit it, in which case the compiler will make a best effort to determine a good name, but might fail.

The above Twig file, will then be compiled to Javascript which will look similar to this:

// greeting.js
greeting = function(env) {
    twig.Template.call(this, env);
}
// pseudo-classical inheritance (http://bolinfest.com/javascript/inheritance.php)
twig.inherits(greeting, twig.Template);

greeting.prototype.render_ = function(stringBuffer, context, blocks) {
    stringBuffer.append("Hello ");
    stringBuffer.append("name" in context ? twig.filter.def(this.env_, context["name"], "World") : "World");
    stringBuffer.append("!");
}

You can then include this file along with the twig.js runtime environment on your website:

<script language="javascript" type="text/javascript" src="twig.js"></script>
<script language="javascript" type="text/javascript" src="greeting.js"></script>
<script language="javascript" type="text/javascript">
    alert(Twig.render(greeting, {name: "Johannes"}));
</script>

Status

While twig.js already provides support for most of Twig's features that you will ever need in your templates. There are some things which are not (yet) available:

• the behavior for a variable named "prototype" is undefined
• some filters are not available (see doc/filters.rst)
• some functions are not available (see doc/functions.rst)
• some tests are not available (see doc/tests.rst)
• sandboxed mode is not available
• compatibility with older Twig versions (anything but Twig head) is untested
• Conditional template includes at runtime are not supported
• strict variables behavior is not supported

If you need support for any of these, patches are very welcome, and if you can attach a few unit tests even better :)

Integration

• With Symfony2: Seamless integration with Symfony2 is provided by the JMSTwigJsBundle.

• With Assetic: If you are not using Symfony2, but Assetic, you can leverage the TwigJsFilter which ships with twig.js.

Documentation

See the doc/ folder for documentation