This repository is not actively maintained

PaperclipJS is a tiny template engine for the DOM. It compiles HTML straight to JavaScript, and only updates the parts it needs to. This means you get über fast apps with a low CPU & memory footprint.

Paperclip was designed for interoperability, and customization. Incorporate it into your existing application, use it with any rendering engine (DOM, Canvas, WebGL, server-side).

basic example:

var pc      = require("paperclip");
var fs      = require("fs");

// readFileSync works in the browser assuming you're using brfs with browserify
var template = pc.template(fs.readFileSync(__dirname + "/template.pc", "utf8"));

// create a view from the template
var view = template.view({
    items: [1, 2, 3],
    addItem: function() {
        this.set("items", this.items.concat(this.items.length + 1));
    }
});

document.body.appendChild(view.render());

template.pc:

<button onclick={{ addItem.bind(this) }}>add item</button>
<ul>
    <li repeat.each={{items}} repeat.as="item">
        {{item}}
    </li>
</ul>

Highlights

• Runs on any platform (web, mobile, NodeJS)
• Super fast. Uses native browser APIs such as cloneNode() for rendering.
• Supports any rendering engine (WebGL, Canvas, SVG, custom).
• Supports inline JavaScript
• Works with old browsers (IE 8+)
• No browser dependencies
• Explicit data binding operators

Installation

NPM: npm install paperclip --save
Bower: bower install paperclip

Resources

• Docs
  • command line usage - compile templates to js from the command line
  • block syntax - dynamic parts of your template
  • modifiers - block helper utilities
  • event handlers - onclick, onsubmit, onmouseover etc.
  • built-in components
  • built-in attributes
  • custom components
  • custom attributes
  • compiling templates in the browser
• Changelog
• Community
  • Google Discussion
  • Gitter Chat
• Rendering engines
  • Pixi - pixijs WebGL rendering engine.
• Examples
  • dbmonster - dbmonster benchmark example
  • pixi.js (WebGL) bunnymark

License (MIT)

Copyright (c) 2015 Craig Condon

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.