cybernetics/brick

MVVM micro library to create large scale and real time web applications in a flash.

Brick

Put the fun back into building web applications

Brick makes it easy to create rich yet maintainable web interfaces by providing a set of composable and extensible components. It uses declarative bindings and observers to sync and update your UI with an underlying data model (or store).

Brick has been built with business needs in mind and provides an architectural pattern (or Brick box) to ease the creation of large scale applications.

10 seconds example

var view = brick('<span>{{name}}</span>', {
  name: 'bredele'
});

view.build(document.body);

Brick is still in an experimental stage and some improvement and new features are coming.

Browser support

Brick is fully tested and supports all mainstream browsers from IE8+.

IE7 requires the use of JSON and querySelector polyfill.

Concept

Brick is not a framework and follows the node.js spirit by providing tiny modules (or bricks) with single responsability. They do one thing and do it well! They are the minimal amount of glue you need to create the web application you want.

Why go into debt to buy an expensive car with high fuel-cost when you can easily afford and only need a smaller and budget friendly car with superior performance.

With equivalent features...

• Observers
• Models and Collections
• Composable Views
• Fast DOM rendering
• Extendable Interpolation
• Automatic DOM Binding
• Extendable data-bindings (via jQuery-like plugins)
• Event-bus Architectural pattern (lifecycle hooks, configs, debug, etc)
• Loose coupling of modules
• Composable and Reusable components
• SVG binding
• IE support

...Brickjs is probably one of the smallest (4kb) and fastest implementation.

Performance matters, really, but we also think you should be able to test, maintain and reuse your code in other projects. That's why Brickjs is based on Commonjs components and offers an ecosystem of independant bricks and modules.

You can reuse its components outside of Brickjs itself, use them on server side with node.js or mix other components to get what you really need.

Last but not least, Brick API is really simple and just few minutes are enough to get into it.

<div>
  <style>
    .brick {
      background: {{ color }};
    }
  </style>
  <div class="brick"> {{ label }} </div>
</div>

var view = brick(el, {
  color: 'red',
  label: 'Hello'
}).build();

//change label
view.set('label', 'World!');

Installation

with component:

$ component install bredele/brick

with nodejs:

$ npm install brickjs

Documentation

We are currently writing a new documentation but you can find the old one in the wiki.

FAQ

Is it different from other MVVM libraries?

In Brickjs, each view has its own bindings and set of plugins unlike some libraries where everything is contained in a global scope. This is important in order to avoid conflict, memory leaks and to maintain your code properly.

view.add('repeat', require('repeat-brick'));

As shown above, you can give a name to your plugins to avoid name conflicts when different views overlap. Your code is readable and also configurable! You can create your own plugins like jQuery (it's as easy as creating a function) and reuse them multiple times inside or outside of your application.

Why support IE8?

Supporting IE8 is really not complicated and does not make Brickjs slower. IE8 doesn't support indexOf and trim. IE8 has shadow node attributes and doesn't support data (we use nodeValue in binding). Thats's pretty much it!

Why a Brick box?

The pattern has an express-like API and is inspired by this article. Iallows you to split your larger application into smaller pieces. Instead having a composite layout where you have a view in a view in a view (and keep references of every views), you have totally independant pieces (with single responsability) that communicate through an event hub.

The main benefits are:

• removing/adding or updating an app doesn't break the others
• easier to test
• easing to maintain
• easier to reuse
• memory safety

You'll see that it'll be easier to get back on your code when your application will become bigger and even a new team member could add, remove or update features in a flash. However. nothing forces you to use it.

Get in Touch

• If you have a related project, plugin or tool, add it to the Wiki page!
• Issues, questions & feature requests: open an issue
• Twitter: @bredeleca

Changelog

See release notes.

License

The MIT License (MIT)

Copyright (c) 2014 Olivier Wietrich [email protected]

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.