dexteryy / URLKit

A lightweight implementation of routing and URL manager

URLKit

• A lightweight implementation of routing and URL manager
• Automatic switch between html5 History API and IE's hashbang

Usage

AMD and OzJS

• URLKit can either be viewed as an independent library, or as a part of OzJS mirco-framework.
• It's wrapped as an AMD (Asynchronous Module Definition) module. You should use it with oz.js (or require.js or similar for handling dependencies).
• If you want to make it available for both other AMD code and traditional code based on global namespace. OzJS provides a mini define/require implementation to transform AMD module into traditional module pattern.
• See http://ozjs.org for details.

Get the code

Add to your project as new dependency

• via bower - bower install urlkit
• via istatic

Or download directly from Github

Dependencies

• mo/lang

Examples

• demo

API and usage

var URLKit = require('urlkit');

• URLKit.parse(url) --
• URLKit.param(urlObj, options) --
• URLKit.SUPPORT_PUSHSTATE --

var url = URLKit({
    baseUrl: '', // optional, '/' for default
    win: window,  // optional
    autotidy: true // optional, true for default
});

• url.listen() --
• url.stop() --
• url.route(rule, handler) --
• url.nav(urlConfig, { /* replace: true, route: false */ }) --
• url.load(url, options) --
• url.set(options) --
• url.checkRules(url, rules) --
• url.getBaseUrl() --

Under construction...

More References

See OzJS Project Homepage

Release History

See OzJS Release History

License

Copyright (c) 2010 - 2013 dexteryy
Licensed under the MIT license.