Super simple dynamic templating.
ie8+
npm install dom-template
var Temple = require('temple')
var UserView = Temple.clone({name: 'bob ross'})
You can also do Temple.clone()
and then later do Temple.set(model)
if
you don't want to load the model right away.
var el = query('#user-profile')
UserView.render(el)
You can call View.clear()
to clear out all listeners, free up memory, and reset the DOM.
You can use {property}
anywhere in the dom to interpolate data.
<p>{greeting}</p>
var el = query('p')
var model = {greeting: 'hallo welt!'}
var view = Temple.clone(model).render(el)
Result:
<p>hallo welt!</p>
Use the each
attribute. Within the element having the each
attribute (and the element itself), all properties are scoped to each element in the array.
<div each='users' data-id={id}>
<p>{name}</p>
<p>{status}</p>
<ul each='comments'>
<li>{this}</li>
</ul>
</div>
To refer to the element itself within the loop, use this
.
You can use a ?
within interpolations to do conditionals -- useful for assigning classes based on bools.
<p class={anonymous ? hide}>{name}</p>
Everything after the ?
is a string that will be interpolated if the boolean is true
If your data model emits change {property}
events, then Temple will automatically update the DOM using your changed data. You never have to re-render the template. Only call render
once at the beginning, and then every change to the data will update in the DOM.
You can customize Temple's entire interface by simply overriding certain properties.
By default, Temple listens for events on your model using model.on('change property', render)
. If you wanted to instead listen with, for example, model.bind(property, render)
, you can do:
Temple.listen = function(model, prop, render) {
model.bind(prop, render)
}
listen
does not need a return value.
By default, Temple uses either of data[property]
or data.get(property) to access your data. To use a library where the model attributes are retrieved with model.fetch(property)
, you can do:
Temple.get = function(model, property) {
return model.fetch(property)
}
The return value of get
should be the retrieved attribute.
You can change the interpolation pattern from {property}
to something else. Pass in the left and right delimiters as strings. For example, to interpolate using #{property}
instead:
Temple.left_delimiter = '#{'
Temple.right_delimiter = '}'
Or to use erb-style, `<%= property %>':
Temple.left_delimiter = '<%='
Temple.right_delimiter = '%>'
You don't have to escape any characters like {
or [
.
Since Temple is designed to render directly into your dom, we might get a flash of {property}
text for interpolated properties on slow connections before the template has loaded data. To avoid this, I recommend setting a template class such as 'temple' to your template elements. Temple will add the class 'temple-rendered' when the data is finished rendering into the element. For example:
<div class='temple'>{prop}</div>
Set .temple
to initially be hidden and .temple.temple-rendered
to display.
.temple {
display: none;
}
.temple.temple-rendered {
display: block;
}
Temple renders and finishes...
<div class='temple temple-rendered'>Hello!</div>
Models that emit change events that you can use alongside Temple include: citizen, model, modella, bamboo.