jQuery Address - Docs

The jQuery Address plugin doesn't add deep linking support automatically but provides the simplest possible API that developers can use to implement it on their own.

The most important concept of the plugin is that any navigation functionality should be invoked only when a change event is dispatched. This ensures that the proper code will be executed each time when the user clicks on the page, uses the back button of the browser or enters the site through a deep link.

Sample Usage

A basic implementation in pure JavaScript can look like this:

$.address.change(function (event) {
    // do something depending on the event.value property, e.g.
    $("#content").load(event.value + ".json");
});

$("a").click(function () {
    $.address.value($(this).attr("href"));
});

The plugin also provides a jQuery function which can be directly used in the following way:

$("a").address();

The above snippet can be extended with an additional function that processes the link value:

$("a").address(function () {
    return $(this).attr("href").replace(/^#/, "");
});

By default the plugin automatically adds the appropriate JavaScript event handler to every link that has a rel attribute in the following format:

<a href="/deep-link"rel="address:/deep-link">Deep link</a>

Supported Browsers

• Internet Explorer 6.0+
• Mozilla Firefox 1.0+
• Safari 1.3+
• Opera 9.5+
• Chrome 1.0+
• Camino 1.0+

API Reference

The jQuery Address plugin does not require initialization. Some of it's properties can be configured with query parameters using the following format:
jquery.address-1.3.min.js?autoUpdate=1&crawling=1&history=1&tracker=trackFunction&state=/&strict=0&wrap=1