https://github.com/hojberg/wrench

tiny javascript router / toolbox for single page evented javascript applications
https://github.com/hojberg/wrench

Last synced: 29 days ago
JSON representation

tiny javascript router / toolbox for single page evented javascript applications

• Host: GitHub
• URL: https://github.com/hojberg/wrench
• Owner: hojberg
• License: mit
• Created: 2010-05-01T22:38:36.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2010-06-23T12:15:08.000Z (over 14 years ago)
• Last Synced: 2024-04-08T16:43:47.635Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 131 KB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# Wrench

Wrench is a tiny javascript router / toolbox that is fully standalone.

It's main purpose is to help making single page evented javascript applications

## Installation

Download the wrench.js file and include it in your html file.

## Usage

Set up a simple application that shows users

	var app = wrench.appify({

		init: function () {

			// this will run after in the boot up process initiated by app.run();

		},

		

		users: {

			list: route("users/list/").to(function () {

				// fetch all the users and show them on the page

			}),

			

			show: route("users/show/:id").to(function (params) {

				// find the user via params['id']

			})

		}

	});

	app.run();

		

You can also do partial routes. Say you have 2 panes in you application. A list and a show pane.

Each pane can be in different states, these states can be saved with partial routes like so:

	var mailapp = wrench.appify({

		init: function () {

			// this will run after in the boot up process initiated by app.run();

		},

	

		list: routePartial("list/:mailbox").to(function () {

			// fetch all the users and show them on the page

		}),

	

		show: routePartial("show/:id").to(function (params) {

			// find the email via params['id']

		})

	});

	app.run();

If both route partials are active this will result in the following url: http://myapp.com/app#list/inbox;show/312

Where "inbox" will be found in params['mailbox'] available function and "321" will be found in params['id'] 

available in the show function

## Dependencies

None :P

## Authors

* Simon Nielsen / hojberg

* Jonas Drewsen / jcd

  

## License

Copyright (c) 2009 Simon Nielsen

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.