README.md

vBind

vBind allows two way data binding between javascript objects and HTML markup using standardised variable interpolation syntax as found in ES6 template strings.

Demo Page

Pre Requisite Instructions:

1. Make sure that your environment has Google Chrome and Phantomjs >= 2.x installed.
2. Make sure nodejs 6 or greater is installed.
3. Clone the repository
4. Navigate to your working copy of the repository on your local system via your command line environment. run

npm install

To run continuous integration locally, execute

grunt devmode

This will spool up the jasmine launcher and any registered jasmine browser launchers that are defined in karma.conf.js.

If you wish your local CI to also run tests against other browsers, install the appropriate karma launchers via npm, e.g.

npm install jasmine-firefox-launcher --save-dev

And add them to karma.conf.js

Library Usage:

First, create a data object to bind.

var boundObject = {
    "greeting": "Hello World! I'm bound!",
    "message": "how are you today?",
    "activated": false,
    "selected": "Item 1",
    "number":1234,
    "template2Label": "Ooogabugga!!"
  };

Next, in your main page create a container to inject your HTML template into.

<div id="container1"></div>

Create a new template file, e.g. /templates/template1.html which looks like this:

<span>Hello World</span>
<select value="${selected}">
  <option>Item 1</option>
  <option>Item 2</option>
</select>
<input value="${greeting}" type="text" />
<input value="${message}" type="text" />
<input checked="${activated}" type="checkbox" />
<input value="${number}" type="number" />
<label>${template2Label}</label>

And finally create a new VBind instance, passing in the path to a template, the container we wish to use, the data to bind against and a model name.

var temp1 = new VBind({
  path: './templates/template1.html',
  container: '#container1',
  data: boundObject,
  model: "boundObject"
});

Markup that uses variable interpolation must be formatted similarly to as if it was a standard ES6 template string, where variables are stored within "${variable}".

vBind reflects changes made to bound object properties in real time. It wraps the getter and setter functions for bound properties and publishes change events to an eventing system when changes are made. This means that changing a property on the underlying bound object using javascript will immediately be reflected on the UI with no need for any manual intervention.