transparency

Transparency is a minimal template engine for browser. It maps JSON objects to DOM elements with zero configuration.

Features

• Data binding by convention - No extra markup in the views
• Collection rendering - No loops and partials
• Nested objects and collections - No configuration, just conventions
• Directives - No custom DSL, just functions
• Template caching - No manual template lookup/compilation/rendering
• Fast - In most real-world cases, it's faster than any other template engine or hand-crafted bindings (*)
• Compatible - Tested on IE6+, Chrome and Firefox.

More details about design principles, performance measurements and specific use cases is available at FAQ

(*) Take with a grain of salt, as "real-world performance" isn't that easy to define or measure. Anyway, jsperf.com should give you an idea. If interested, see other performance tests at browser folder.

Try it

See live examples and play around at http://leonidas.github.com/transparency/

Use it

Get the compiled and minified version and include it to your application. jQuery is optional, but if you happen to use it, Transparency registers itself as a plugin.

<script src="js/jquery-1.7.1.min.js"></script>
<script src="js/transparency.min.js"></script>

For server-side use, see spec folder and awesome jsdom for the details.

Examples

Here's some of examples. For further details, please see examples folder, unit tests and the source code.

Assigning values

Transparency binds JavaScript objects to DOM a element by id, class,element name, name attribute and data-bindHTML5 data attribute .

Values are escaped before rendering.

Template:

<div id="container">
  <div id="hello"></div>
  <div class="goodbye"></div>
  <span></span>
  <input type="text" name="greeting" />
  <button class="hi-button" data-bind="hi-label"></button>
</div>

Javascript:

var hello = {
  hello:      'Hello',
  goodbye:    'Goodbye!',
  span:       '<i>See Ya!</i>',
  greeting:   'Howdy!',
  'hi-label': 'Terve!' // Finnish i18n
};

// with jQuery
$('#container').render(hello);

// ..or without
Transparency.render(document.getElementById('container'), hello);

Result:

<div class="container">
  <div id="hello">Hello</div>
  <div class="goodbye">Goodbye!</div>
  <span>lt;i&gt;See Ya!&lt;/i&gt;</span>
  <input type="text" name="greeting" value="Howdy!" />
  <button class="hi-button" data-bind="hi-label">Terve!</button>
</div>

Iterating over a list

Template:

<ul id="activities">
  <li class="activity"></li>
</ul>

Javascript:

var activities = [
  {activity: 'Jogging'},
  {activity: 'Gym'},
  {activity: 'Sky Diving'},
];

$('#activities').render(activities);

// or
Transparency.render(document.getElementById('activities'), activities);

Result:

<ul id="activities">
  <li class="activity">Jogging</li>
  <li class="activity">Gym</li>
  <li class="activity">Sky Diving</li>
</ul>

Iterating over a list with plain values

Template:

<div>
  <div class="comments">
    <span></span>
  </div>
</div>

Javascript:

var comments = ["That rules", "Great post!"]

$('.comments').render(comments);

Result:

<div>
  <div class="comments">
    <span>That rules</span>
    <span>Great post!</span>
  </div>
</div>

Iterating over a list with plain values, using listElement class

Template:

<div>
  <div class="comments">
    <label>comment</label><span class="listElement"></span>
  </div>
</div>

Javascript:

var comments = ["That rules", "Great post!"]

$('.comments').render(comments);

Result:

<div>
  <div class="comments">
    <label>comment</label><span class="listElement">That rules</span>
    <label>comment</label><span class="listElement">Great post!</span>
  </div>
</div>

Nested lists

Template:

<div class="container">
  <h1 class="title"></h1>
  <p class="post"></p>
  <div class="comments">
    <div class="comment">
      <span class="name"></span>
      <span class="text"></span>
    </div>
  </div>
</div>

Javascript:

var post = {
  title:    'Hello World',
  post:     'Hi there it is me',
  comments: [ {
      name: 'John',
      text: 'That rules'
    }, {
      name: 'Arnold',
      text: 'Great post!'
    }
  ]
};

$('.container').render(post);

Result:

<div class="container">
  <h1 class="title">Hello World</h1>
  <p class="post">Hi there it is me</p>
  <div class="comments">
    <div class="comment">
      <span class="name">John</span>
      <span class="text">That rules</span>
    </div>
    <div class="comment">
      <span class="name">Arnold</span>
      <span class="text">Great post!</span>
    </div>
  </div>
</div>

Nested objects

Template:

<div class="person">
  <div class="firstname"></div>
  <div class="lastname"></div>
  <div class="address">
    <div class="street"></div>
    <div class="zip"><span class="city"></span></div>
  </div>
</div>

Javascript:

var person = {
  firstname: 'John',
  lastname:  'Wayne',
  address: {
    street: '4th Street',
    city:   'San Francisco',
    zip:    '94199'
  }
};

$('.person').render(person);

Result:

<div class="container">
  <div class="firstname">John</div>
  <div class="lastname">Wayne</div>
  <div class="address">
    <div class="street">4th Street</div>
    <div class="zip">94199<span class="city">San Francisco</span></div>
  </div>
</div>

Directives

Directives are used for manipulating text or html values and setting element attributes. In addition to having an access to the current data object through this, directives also receive the current element as a parameter, which makes it easy to, e.g, hide it.

The return value of a directive function can be either string or object. If the return value is string, it is assigned to the matching elements as text content. If the return value is an object, keys can be either text, html or any valid element attribute, e.g., class, src or href. Values are assigned accordingly to the matching elements.

Template:

<div class="person">
  <span class="name"></span>
  <a class="email"></a>
</div>

Javascript:

person = {
  firstname: 'Jasmine',
  lastname:  'Taylor',
  email:     '[e-mail]'
};

directives =
  name:  function(element) { return this.firstname + " " + this.lastname; }
  email: function(element) { return {href: "mailto:" + this.email}; }
};

$('.person').render(person, directives);

Result:

<div class="person">
  <span class="name">Jasmine Taylor</span>
  <a class="email" href="mailto:[e-mail]">[e-mail]</a>
</div>

Nested directives

Template:

<div class="person">
  <span class="name"></span>
  <span class="email"></span>
  <div class="friends">
    <div class="friend">
      <span class="name"></span>
      <span class="email"></span>
    </div>
  </div>
</div>

Javascript:

person = {
  firstname:  'Jasmine',
  lastname:   'Taylor',
  email:      '[e-mail]',
  friends:    [ {
      firstname: 'John',
      lastname:  'Mayer',
      email:     '[e-mail]'
    }, {
      firstname: 'Damien',
      lastname:  'Rice',
      email:     '[e-mail]'
    }
  ]
};

nameDecorator = function() { return {html: "<b>" + this.firstname + " " + this.lastname + "</b>"}; };

directives = {
  name: nameDecorator,
  friends: {
    name: nameDecorator
  }
};

$('.person').render(person, directives);

Result:

<div class="person">
  <span class="name"><b>Jasmine Taylor</b></span>
  <span class="email">[e-mail]</span>
  <div class="friends">
    <div class="friend">
      <span class="name"><b>John Mayer</b></span>
      <span class="email">[e-mail]</span>
    </div>
    <div class="friend">
      <span class="name"><b>Damien Rice</b></span>
      <span class="email">[e-mail]</span>
    </div>
  </div>
</div>

Development instructions

You'll need node.js 0.6.x and npm.

Install uglify-js and coffee-script:

npm install -g uglify-js
npm install -g coffee-script

Run tests

npm install && npm test

Run tests during development for more verbose assertion output

node_modules/jasmine-node/bin/jasmine-node --coffee --verbose spec

Generate Javascript libs

cake build

Contributing

All the following are appreciated, in an asceding order of preference

1. A feature request or a bug report
2. Pull request with a failing unit test
3. Pull request with unit tests and corresponding implementation

In case the contribution is going to change Transparency API, please create a ticket first in order to discuss and agree on design.

There's an article regarding the original design and implementation. It might be worth reading as an introduction.