README.md

DatabindExtension

One-way databinding extension for Nunjucks templating engine

Options

When constructing the DatabindExtension, you can supply the following options: updateMode, Determines how the bindings are updated. Can be either 'auto' or 'manual'. Default is 'auto'. bindElementPrefix, The prefix for binding wrapper elements. Default is 'boundelement-'

Usage

To use the extension you must create a Nunjucks environment and add the DatabindExtension extension

var nunjucksEnv = new nunjucks.Environment(new nunjucks.WebLoader('/templates'), {
	autoescape: true
});
nunjucksEnv.addExtension('BindExtension', new DatabindExtension({}));

The DatabindExtension extensions provides a bind tag for you to use in your templates

{% bind %}
    <ul>
    {% for item in items %}
        <li>{{item}}</li>
    {% endfor %}
    </ul>
{% endbind %}

Any content within the {% bind %}{% endBind %} tags will be automatically re-rendered when the template's data object changes. However, doing a full render whenever any part of the object is modified is far from optimal and can have unintended side effects, so the {% bind %} tag accepts an optional parameter indicating what part of the object needs to change to trigger a re-render.

{% bind "items" %}
    <ul>
    {% for item in items %}
        <li>{{item}}</li>
    {% endfor %}
    </ul>
{% endbind %}

Including "items" tells the extension to only update this part of the template when the corresponding items attribute is modified.

If you choose to update bindings manually (when specifying updateMode: 'manual'), you will have to call the updateBindings method.