broke-client.js, version 0.2b
The documentation is a work in progress.
Please refer to the examples shipped with the release for a full understanding.
You may find a distribution file inside the "dist" directory or you can roll up your own distribution file easily with the build settings and libraries inside the "bin" directory.
For everyone of you who do not know the Django Web Framework here is a summary of the philosophy behind Broke:
* MTV pattern http://en.wikipedia.org/wiki/Model-Template-View * DRY principle (Do Not Repeat Yourself) * Object-relational mapping * Elegant URL design * An event system similar to the HTTP Request/Response * Highly configurable
Broke take advantage of the latest 'onhashchange' event, if present, and if not it will fake one. Generally Broke uses the 'elements' method to trigger 'broke.request' events instead of the 'hashchange' method. Please refer to the 'events' documentation for more insight.
I'll try to summarize the pros and cons of both solutions:
* hashchange: * pros: * you can bookmark the page * the forward/backward buttons, changing the hash, trigger a request * cons: * poor control over the event happening in the page * whenever a link tries asks for the same url twice, it does not get intercepted twice but just once, the first time the hash changes (which could both be good and bad) * elements: * pros: * you can bookmark the page * more control over the event, since you can prevent default actions on forms/links/whatever, like submit or visualization of the hash on the page url * every time you trigger a request, it gets intercepted by broke * cons: * the forward/backward buttons do not trigger any kind of events on the page, so going backward and forward does nothing. So far I could not think of a good method to prevent this
For a good understanding, please refer to the examples.
* unit tests * a better documentation
* Franco Bugnano <firstname.lastname@example.org>