https://github.com/garygreen/lightrouter
Ultra lightweight javascript router
https://github.com/garygreen/lightrouter
Last synced: 4 months ago
JSON representation
Ultra lightweight javascript router
- Host: GitHub
- URL: https://github.com/garygreen/lightrouter
- Owner: garygreen
- Created: 2014-07-08T09:02:24.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-06-27T14:13:39.000Z (over 9 years ago)
- Last Synced: 2024-10-02T15:04:51.097Z (5 months ago)
- Language: JavaScript
- Size: 367 KB
- Stars: 68
- Watchers: 3
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Lightrouter
===========
[](https://travis-ci.org/garygreen/lightrouter)
Ultra lightweight javascript router for those that need the most basic simple javascript routing.
```javascript
// Initialise the router
var router = new LightRouter({
type: 'path', // Default routing type
handler: handler, // Handler for string-based route callbacks
pathRoot: 'my-app/path', // Base path for your app
routes: {
'': 'home', // Base Url
'users': 'userIndex',
'users/{id}': 'userShow',
'users/(.*)': function(params) { /* User: params[0] */ },
'users/(?:create|{id}/edit)': function(params) { /* Create/Edit User: params.id */ }
}
});
// Route callback handlers
var handler = {
home: function() { },
userIndex: function() { },
userShow: function(params) { /* Show user: params.id */ }
};
// Run the router
router.run();
```
## Features
* Super fast, regexes and objects are only initialized when they need to be.
* Predictable and easy regex-based, no new syntax to learn.
* Most routers use `:param` style syntax which interferes with regexes non-consuming match `(?:`
* Node support
* Support for matching from a base path (see `pathRoot`).
* Traditional URL matching and support for hash based routing for single page apps.
* Fully unit tested.
#### Adding routes
Routes can be added with the `add()` method
```javascript
router.add(/anywhere-in-url-match\/(\w+)/, function(params) { });
router.add('articles/{id}', function(params) { console.log('loading article ' + params.id); });
router.add('user/{userId}/show', function(params) { console.log('showing user', params.userId); });
```
#### Routing Types
Type | Matches Against
-------|----------------------------
path | window.location.pathname
hash | window.location.hash
### Base/Path Root Support
The given `pathRoot` will be essentially stripped out when matching the routes:
```javascript
// Initialise the router
var router = new LightRouter({
type: 'path',
path: 'my-app-path/users/1',
pathRoot: 'my-app-path',
routes: {
'users/{id}': function(params) { console.log('showing user', params.id); }
}
}).run();
```
API
---
### add([string|regex], callback)
Adds a route and calls the callback function if the routing url matches. Callback can be either a string (with use of the `handler` option) or closure.
### empty()
Empty's all the routes
### setType(['hash'|'path'])
Set's the default routing type to either by hash or path
### setPathRoot([string]url)
Set's the paths root url (the paths root url will be removed when matching against routes).
### setPath([string]path)
Set's the path to match routes against (will default to window.location.pathname)
### setHash([string]hash)
Set's the hash to match routes against (will default to window.location.hash)
### setContext([object]context)
Set's the context to call matched routes under.
### setHandler([object]handler)
Set the object handler for string-based route callbacks.
### getUrl([type])
Get's the url to match routes against (will default to get the url on the default routing type as set in the options or by `setType()` or for the type if supplied.)
### match(route, [string|closure]callback)
Attempt to match a one-time route.
### run()
Checks the routes against the url and calls the associated route function. Will also return the matched `Route` object.