durruti
v0.0.23
Published
Micro isomorphic JavaScript library for building user interfaces.
Downloads
7
Readme
Durruti
Micro isomorphic JavaScript library for building user interfaces.
Why?
Durruti aims to make isomorphic component-based JavaScript web apps easier to develop. It's focused on simplicity rather than performance.
It uses DOM diffing and patching. Components can use any sort of string-based templates.
It doesn't do view model binding or event listeners on it's own. It takes a DIY approach and gives you have full control on when to re-render components, or how to handle events.
Features
- Lightweight: No dependencies, the client-side libraries are just
~4KB. - Simple Components: Components are basic JavaScript classes/functions with three methods.
- String Templates: Use strings or any string-based templates for components.
- Store: Optional store library with change events and history. Makes it easy to share state between client and server.
How to use
Quick use
<script src="durruti.js"></script>
<div id="app"></div>
<script>
function Main () {
this.render = function () {
return '<div>Main Component</div>'
}
}
durruti.render(Main, document.querySelector('#app'))
</script>Durruti
The main Durruti library (durruti.js) handles component rendering and mounting/mounting.
It exposes a main render method that takes two parameters:
- The first is a JavaScript class/function or object representing a Durruti component
- The second is an optional DOM node where the rendered component will be inserted. If you don't specify the DOM node, the render method will return the rendered component as a string.
Durruti components are basic JavaScript classes or objects that can expose three methods.
render: The render method is mandatory and must return the component template as a string. The template must contain a top level DOM node.mount: The optional mount method is called after the component is added to the DOM. The mount method receives the current DOM node as a parameter.unmount: The optional unmount method is called before the component is removed from the DOM.
Example
Render the Main component to an #app DOM node.
function Main () {
// mount and unmount are optional
this.mount = function () {
console.log('Mount was added to the DOM')
}
this.unmount = function () {
console.log('Mount is about to be removed from the DOM')
}
this.render = function () {
return '<div>Main Component</div>'
}
}
durruti.render(Main, document.querySelector('#app'))Re-rendering view model example
Clicking the button will increase the counter, and re-render the component.
function Main () {
var self = this
self.counter = 0
function increaseCount () {
self.counter++
// re-render the component
durruti.render(self, self.$container)
}
// mount and unmount are optional
self.mount = function ($container) {
// expose the container to the other methods
self.$container = $container
$container.querySelector('button').addEventListener(increaseCount)
}
self.render = function () {
return '<div>\Main Component <p>Counter: ' + self.counter + '</p><button>Increase count</button></div>'
}
}
durruti.render(Main, document.querySelector('#app'))Server render
When rendering on the server, you must use the server() method on each page render.
This example uses Express, but can be adapted to any Node.js framework.
var express = require('express')
var app = express()
app.get('/:route', function (req, res) {
res.send(durruti.server().render('<html><body><div id="app">' + durruti.render(Main) + '</div></body></html>'))
})Store
The store library can be used to store data, with change events and history.
To use it, include the store.js file.
Initialize a new store with new durruti.Store(options). The options parameter is optional hash.
Available options are:
history: By default enabled in browsers, and disabled on the server. You can manually disable or enable it.
Methods
Stores have four methods:
set: Set the store value.get: Get the current store value.list: List all values that the store had. History must be enabled.on: Attach callback to events. The only event available right now ischange. It triggers after the store value has changed.
Example
var model = new durruti.Store()
model.on('change', function () {
console.log('The new store value is ' + model.get())
})
model.set('New Model Value')License
Durruti is licensed under the MIT license.