seam

Seam binds your JS logic to the DOM by adding configuration to the markup.

Seam

Seam binds your JS logic to the DOM by adding configuration to the markup.

Ever wanted to bind your JS logic to the DOM by doing something like this in your HTML?

    <p data-bind="value: name"></p>
    <button data-listen="click: doSomething"></button>

Seam allows you to do just that. It will create the link between your HTML and your JavaScript logic.

Installation

npm install seam

How to use

Require seam:

var Seam = require("seam");

Let's start with a simple example. We would like to set the value of "name" in the paragraph.

    <p data-bind="value: name"></p>
    // The object to display in the DOM 
    var someone = {
        // This is the value that we want to display in the paragraph 
        name: "John",
        type: "Doe"
    };
 
    // We start by initializing Seam 
    var seam = new Seam();
 
    // Then we add a seam plugin called 'bind' 
    seam.add("bind", {
 
        // Which has a method called value 
        valuefunction (nodeparam) {
            // That will set the innerText of the dom to "John" 
            node.innerText = someone[param];
        }
    });
 
    // Then we tell it where to find the DOM elements to bind 
    seam.apply(document.querySelector("p"));

Where data-bind is configured while adding the plugin to seam. We could have used any other allowed name, such as 'listen', 'style', 'css', 'text' or even 'another-plugin_for-seam'.

Seam will then execute the method 'value' in the plugin 'bind', passing it two things:

  • {HTMLElement} the node to which the data-attribute is applied
  • {String} the parameters specified in the data-attribute, after the name of the method (name in our case)

We've just bound some JS logic to a dom element. This seems overkill for such simple task, but it'll make more sense when we'll add more plugins, and especially when they are plugins that we can just reuse.

Let's add more plugins, one for setting data into the DOM, one for listening to DOM events.

    <section>
        <p data-bind="value: name"></p>
        <button data-listen="click: doSomething"></button>
    </section>

In this case, we have two plugins, one called 'bind', and the other one called 'listen'. We can configure Seam to accept more than one plugin by calling the 'addAll' method instead of just 'add':

    // This is some UI with a doSomething method: 
    var ui = {
        doSomethingfunction () {
            // do something 
        }
    }
 
    seam.addAll({
        // This is the plugin that we have seen before 
        bind: {
            valuefunction (nodeparam) {
                node.innerText = someone[param];
            }
        },
 
        // This is the new plugin called listen 
        listen: {
            clickfunction (nodemethod) {
                node.addEventListener("click", function (event) {
                    ui[method](event);
                }, true);
            }
        }
    });

We still have the same plugin for adding data to the DOM. We also have added a new plugin called 'listen' that adds an eventListener to the targeted DOM. Whenever the user clicks on this DOM element, it will call the method 'doSomething' on UI.

Of course, this example is very limited, as we can't bind a value from an object to something else than innerText, and we can't listen to another event than 'click' as long as we don't create new functions for handling them. Moreover, we can't change the object from which we get the value, nor can we change the object on which to call the method when a click occurs.

So let's create some reusable plugins. We pretend that the object that contains the data is a backbone.Model, which triggers events whenever something changes. We could also call a method on a backbone.View when a click occurs.

    <section>
        <p data-bind="change: name, innerText"></p>
        <button data-event="listen: click, alert, name"></p>
    </section>
    // We have a backbone.Model 
    model.set("name", "Seam");
 
    // We have a backbone.View with an alert method. It alerts the value of "name" 
    view.alert = function (eventparam) {
        alert(model.get(param);
    };
 
    /**
     * We create a constructor for a binding plugin
     * It takes a model as a parameter so it knows where to get the data
     */
    function Binding(model) {
 
        // This is the change method of our plugin 
        this.change = function (nodekeyattribute) {
 
            // We need to set the innerText of the DOM to the current value 
            node[attribute] = model.get(key);
 
            // Whenever the value changes, we update the dom 
            model.on("change:" + key, function (newValue) {
                node[attribute] = newValue;
            });
 
        };
    }
 
    /**
     * Then we create a constructor for an event plugin
     * It takes a view as parameter, so it knows where to call the method
     */
    function Event(view) {
 
        this.event = function (nodeeventNamemethodNameparam) {
            node.addEventListener(eventName, function (event) {
                view[methodName](event, param);
            });
        };
 
    }
 
    // We create our Seam 
    var seam = new Seam();
 
    // Then we add our plugins 
    seam.add({
 
        // We initialize a new binding plugin with the model we want to listen to 
        "bind": new Binding(model),
 
        // We initialize a new event plugin with the view we want to call the methods on 
        "event": new Event(view)
 
    });
 
    // And finally, we apply it to the parent element of the DOM that we want to bind to this logic 
    seam.apply( document.querySelector("section") );

In this more complete example, we have a Binding plugin that will listen to changes on a backbone.Model to update the DOM. We have created a reusable data-binding plugin that can now be reused to bind as many backbone.Model as we want to our DOM. We have even specified which property of the DOM node we want to update. It could be the className, or even value for form elements!

Then we have created an Event listener that will listen to 'click', or any other event we want to listen to, and forward the event to the method of the view that we have initialized the plugin with.

We can also call multiple methods on the same DOM element:

    <p data-plugin="method1: param1, param2, paramN; method2: param1, param2, paramN"></p>

Or we can call multiple plugins on the same DOM element

    <p data-plugin1="method: param1, param2" data-plugin2="method1: param1, param2; method2, param1, param2"></p>

LICENSE

MIT