yamvish-router v0.3.1

yamvish-router

In-place routing plugin for yamvish.

It uses routedsl to manage matching.

install

As it comes as an CommonJS module usable with browserify by example, simply install it with npm in your project folder, where you have previously installed yamvish.

npm i yamvish-router --save

Require : Browser side, it uses history pushState/popState by default and so you should also load a polyfills for IE8/IE9 (as min-history)

Example with simple route

When you define a route on a node, it will be showned (style.display = '') only if route matchs.

var y = require('yamvish');
require('yamvish-router');

var rootContext = new y.Context();

y.router.bindHistory(rootContext); // browser side only

var viewContainer = y.view()
.div(
	y().route('/$') // assign route to containing div
	.p('home content')
)
.div(
	y().route('/hello') // assign route to containing div
	.p('hello page content')
	.div(
		y().route('./world') // assign route to containing div
		.p('hello/world content')
	)
)
.toContainer(rootContext)
.mount('#anID');

rootContext.toAgora('route:update', '/hello/world');

Example with simple route that catch variables

When a route catch some variables it injects them in curent context under '$route'.

var y = require('yamvish');
require('yamvish-router');

var rootContext = new y.Context();

y.router.bindHistory(rootContext); // browser side only

var view = new y.View()
// bind this view to root router (i.e. that will respond to y.navigateTo)
.rootRouter()
.div(
	y.view().route('/$') // assign route to containing div
	.p('home content')
)
.div(
	y.view().route('/hello/s:page')
	.p('content for {{ $route.params.page }}')
)
.toContainer(rootContext)
.mount('#anID');

rootContext.toAgora('route:update', '/hello/world');

nest example coming soon.

Licence

The MIT License

Copyright (c) 2015 Gilles Coomans gilles.coomans@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.