Routie

Routie is a javascript hash routing library. It is designed for scenarios when push state is not an option (IE8 support, static/Github pages, Phonegap, simple sites, etc). It is very tiny (800 bytes gzipped), and should be able to handle all your routing needs.

Download

• Development
• Production
• Source

Usage

There are three ways to call routie:

Here is the most basic way:

routie('users', function() {
    //this gets called when hash == #users
});

If you want to define multiple routes you can pass in an object like this:

routie({
    'users': function() {

    },
    'about': function() {
    }
});

If you want to trigger a route manually, you can call routie like this:

routie('users/bob');  //window.location.hash will be #users/bob

Advanced

Routie also supports regex style routes, so you can do advanced routing like this:

routie('users/:name', function(name) {
    //name == 'bob';
});
routie('users/bob');

optional params:

routie('users/?:name', function(name) {
    //name == undefined
    //then
    //name == bob
});
routie('users/');
routie('users/bob');

wildcard:

routie('users/*', function() {
});
routie('users/12312312');

catch all:

routie('*', function() {
});
routie('anything');

Dependencies

None

Supports

Any modern browser and IE8+

Tests

Run make install, then make test, then go to http://localhost:8000/test

License

(The MIT License)

Copyright (c) 2012 Greg Allen <me@jga.me>

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.