The module allows to generate URIs and URLs based on server-side defined routes.

Place module in /modules/ and include the call in your bootstrap. Also, you need to include jquery plugin, like this:

<script type="text/javascript" src="/media/js/jquery.kohana.router-0.3.js"></script>

Add your stuff to onload callback and pass it to constructor:

var onload = function () {
    this.get('media').uri({file: 'img/logo.png'});   // media/img/logo.png
    this.url('media', {file: 'img/logo.png'});       // /media/img/logo.png
    this.url('media', {file: 'img/logo.png'}, true); // http://domain.com/media/img/logo.png
};

var router = $.kohanaRouter({
    onload: onload
});

or add as property:

router.onload = onload;

It is assumed that on the server the route is set

Route::set('media', 'media(/<file>)', array(
        'file' => '.+',
    ))
    ->defaults(array(
        'controller' => 'foo',
        'action'     => 'bar',
        'file'       => null,
    ));

By defaults router requests all routes (except filtrated, see bellow) from the server. You may specify array of routes that you really need:

var list = ['foo', 'bar'];

and pass it to constructor:

var router = $.kohanaRouter({
    // ...
    list: list
    // ...
});

or define it as defaults:

$.kohanaRouter.defaults.list = list;

For security reasons (or for decrease overhead) you may add to the filter some routes, that should not be passed to client. For example, if you have admin route

Route::set('admin', 'admin/<action>')
    ->defaults(array(
        'controller' => 'baz',
        'action'     => 'bat',
    ));

add to blacklist it in config of the module

'filter' => array(
    // ...
    'admin', // crackers no need to know this :)
    // ...
),

You may want to handle AJAX error event and you have this ability. Simply you need to specify onerror callback like this:

var onerror = function (jqXHR, textStatus, errorThrown) {
    // some sode
};

and pass this function to constructor:

var router = $.kohanaRouter({
    // ...
    onerror: onerror
    // ...
});

or add as property:

router.onerror = onerror;

By defaults url of source is /jsroute/get and it correspond to backend, but you can redefine this setting if need:

$.kohanaRouter.defaults.source = '/foo/bar';

MIT