Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/invis1ble/kohana-jsroute
Client side routing for Kohana
https://github.com/invis1ble/kohana-jsroute
frontend javascript kohana module routing
Last synced: about 2 months ago
JSON representation
Client side routing for Kohana
- Host: GitHub
- URL: https://github.com/invis1ble/kohana-jsroute
- Owner: Invis1ble
- Created: 2012-05-06T20:30:13.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2012-05-24T20:07:06.000Z (over 12 years ago)
- Last Synced: 2023-04-08T19:18:50.719Z (over 1 year ago)
- Topics: frontend, javascript, kohana, module, routing
- Language: JavaScript
- Size: 129 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JSRoute module
## Wherefore?
The module allows to generate URIs and URLs based on server-side defined routes.
## Setup
Place module in `/modules/` and include the call in your bootstrap.
Also, you need to include jquery plugin, like this:
```html
```
## Usage Examples
### Generate URIs and URLs
Add your stuff to `onload` callback and pass it to constructor:
```javascript
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:
```javascript
router.onload = onload;
```
It is assumed that on the server the route is set
```php
Route::set('media', 'media(/)', 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:
```javascript
var list = ['foo', 'bar'];
```
and pass it to constructor:
```javascript
var router = $.kohanaRouter({
// ...
list: list
// ...
});
```
or define it as defaults:
```javascript
$.kohanaRouter.defaults.list = list;
```
### Security and filter
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
```php
Route::set('admin', 'admin/')
->defaults(array(
'controller' => 'baz',
'action' => 'bat',
));
```
add to blacklist it in [config](https://github.com/Invis1ble/kohana-jsroute/blob/master/config/jsroute.php) of the module
```php
'filter' => array(
// ...
'admin', // crackers no need to know this :)
// ...
),
```
### Customization
#### Callbacks
You may want to handle AJAX `error` event and you have this ability. Simply you need to specify `onerror` callback like this:
```javascript
var onerror = function (jqXHR, textStatus, errorThrown) {
// some sode
};
```
and pass this function to constructor:
```javascript
var router = $.kohanaRouter({
// ...
onerror: onerror
// ...
});
```
or add as property:
```javascript
router.onerror = onerror;
```
#### Controller url
By defaults url of source is `/jsroute/get` and it correspond to backend, but you can redefine this setting if need:
```javascript
$.kohanaRouter.defaults.source = '/foo/bar';
```
## License
[MIT](http://www.opensource.org/licenses/mit-license.php)