virtual-model v1.3.0

virtual-model

Turn a template into a virtual dom.

See also

virtual-model uses virtual-dom, virtual-html, and observify.

This project is called virtual-model, but it really acts as both a model & view, similar to projects like Ractive and Vue.js, and was inspired by ampersand-virtual-dom-mixin.

Example

var template = require('lodash.template');
var model = require('virtual-model');

var str = '<div style="height:500px; background-image: url(<%= img %>);"';
str += ' data-foo="<%= foo %>"><%= text %> <%= count %></div>';

var options = {
  el: document.body,
  template: template(str),
  data: { 
    count: 0,
    text: 'pizzzzzaaaaa',
    img: 'http://a.fod4.com/misc/Internet%20Pizza.gif'
  }
};

var counter = model(options);

setInterval(function () {
  options.data.count += 2;

  if (options.data.count == 10) {
    options.data.text += ' is awesoooooooome';
  }

  counter.set(options.data);
}, 2700);

Install

npm install --save virtual-model

Usage

var model = require('virtual-model');

var example = model(options, callback);

The options object has three properties:

• template
  • can take a string or a compiled template function like Handlebars.compile(str)
• data
  • optional. an object with the data you want to pass to the template function
• el
  • optional. the html node that will serve as the parent element for the view

The optional callback provides an err parameter that exists if there was an error parsing the html.

Methods

example.render(callback);

Renders the the template with the data and updates the element.

The optional callback provides an err parameter that exists if there was an error parsing the html.

example.set(keypath, data);

data is an object, array, or value that will update the data of the model and automatically run example.render() to update the dom.

Optionally specify the keypath for the property in the data that you'd like to set. The keypath can be nested, like this: 'some.nested.path', where the data in the model looks like this:

{ some: { nested: { path: 'value' } } }

example.get(keypath);

Get data from the model. Optionally specify a keypath to get a specific property from the data.

Like the .set method, the keypath can be nested.

example.html();

Returns the current html.

example.appendTo(el);

The el argument is the html node that will serve as the parent element of the view.

Properties

example.tree

The virtual-dom tree.

example.el

The element that can be added to the dom of the web page.

Events

example.on('change', function (value) {});

example.on('update', function (model) {});

License

MIT