A client-side router for single-page apps
JavaScript HTML
Latest commit 1545f53 Jan 4, 2017 @TehShrike committed on GitHub Linking to sausage-router and noting location arg
Permalink
Failed to load latest commit information.
test
.gitignore
.travis.yml
browserstack.json
changelog.md
hash-location-mock.js
hash-location.js
index.html
index.js
mock.js
package.json
readme.md

readme.md

hash-brown-router

A router that is only concerned with single-page apps that want to change state based on the bits of the url after the hash.

Want to use this router, but with go translated to pushState? Use this library with sausage-router!

Why another client-side routing library?

This library:

  1. uses a path-parsing library that lets you generate links programmatically
  2. comes with a handy stub for testing - any library that takes hash-brown-router can use the included stub in unit tests.

Example

var router = require('hash-brown-router')()

var mainElement = document.getElementById('main')

router.add('/', function() {
    mainElement.innerHTML = 'Thank you for visiting my site! This is the home screen.'
})

router.add('/blog-post/:blogPostName', function (parameters) {
    mainElement.innerHTML = getHtmlForBlogPost(parameters.blogPostName)
})

router.on('not found', function (path, querystringParameters) {
    alert('Couldn\'t find that page, sorry! Redirecting you to the home screen.')
    router.location.replace('/')
})

router.evaluateCurrent('/')

API

Construction

var makeRouter = require('hash-brown-router')

var router = makeRouter(options, [location object])
  • options: an object of options
    • reverse: By default, routes are matched from oldest to newest. So if there are multiple matching routes for the current url, the first one that was added is used. If reverse is set to true, then the most recently added match is used.
  • location, an abstraction of the browser's location matching this interface

The router is an event emitter that emits:

  • not found: whenever the route is evaluated and there is no matching handler for that route. It is passed two arguments: the path (a string) and the querystring parameters (an object).

router.add(routeString, cb) - add routes

router.add('/page/:pageName', function(parameters) {
    console.log(parameters.pageName)
})

Parses express-style route paths, using a fork of path-to-regexp.

router.location.go(newPath) - navigate to a new path

router.location.go('/some-other/path')

Changes the current location hash.

router.location.replace(newPath) - replace the current route in the browser history

router.add('/page/:pageName', function(parameters) {
    if (doesNotExistInTheDatabase(parameters.pageName)) {
        router.location.replace('/pageNotFound')
    }
})

Changes the current location hash, replacing the last location in the browser history, i.e. location.replace(location.origin + location.pathname + '#' + newPath).

router.location.get() - get the current path, without a leading hash

router.location.get() // => '/page/home'

router.evaluateCurrent(defaultPath) - evaluate the current url

Forces the library to evaluate the current route from location.hash. Probably best do do once the dom is ready.

router.evaluateCurrent('/home')

If location.hash is currently empty, it changes the path to the default path value you pass in.

router.stop()

If for some reason you want the router to start ignoring hash change events. you can call router.stop().

Testability

Want to use a stub of this library that works in node? Just require('hash-brown-router/mock') for all your automated testing needs.

Browser support

Build Status

Automated testing in Chrome, Firefox, Safari, and IE9+ provided by Browserstack.

License

WTFPL