rage-route

rage-route

Tiny, feature lite, super basic client router

Why rage?

This was built as a very feature light replacement for page.js.

Ships with es6 styled module and commonjs module for your rolling pleasure.

Install

$ npm install --save rage-route

Usage

import { addRoute, addRedirect, route, history } from 'rage-route'
addRoute('/somepage', 'Page Title', (state) => handlePageRoute(state))
addRedirect('/someotherpage', '/somepage')
addRoute('.*', 'Everything Else', (state) => handleDefaultRoute(state))
...
route('/somepage')
...
console.log(history.previous)
console.log(history.current)

API

Add route handler

addRoute(*path, *title, *callback)

• path [string - required] (ex. '/somepage')
• title [string - required] (ex. 'Page Title')
• callback [function - receives state object - required] (ex. (state) => fn(state))

Add redirect from a new path to an existing path

addRedirect(*newPath, *existingPath)

• newPath [string - required] (ex. '/someotherpage')
• existingPath [string - required] (ex. '/somepage')

Route to another page, triggering callback set in addRoute

route(*path, *title, *state, *noStore)

• path [string - required] (ex. '/somepage')
• title [string - optional] (ex. 'Page Title')
• state [object - optional] (ex. {foo: 'bar'})
• noStore [boolean - optional - don't store state in history] (ex. true)

Get array of registered routes

list()

We also expose a history object with the previous and current page

history

• previous [string] previous page
• current [string] current page

License

MIT © Andrew Carpenter