An alternative to `m.route`. Exposes the History API using a thin Stack abstraction with routing utility functions
Last updated 5 years ago by emilbayes .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install mithril-history-router 
SYNC missed versions from official npm registry.


An alternative to m.route. Exposes the History API using a thin Stack abstraction with routing utility functions


npm install mithril #peer dependency

npm install --save mithril-history-router


var m = require('mithril')
var r = require('mithril-history-router')

r.route(document.body, '/', {
  '/': {
    controller: function () {},
    view: function (ctrl) {
      return m('a[href=/other]', {config: r.anchor()})
  '/other': {
    controller: function () {},
    view: function (ctrl) {
      return m('h1', 'Page 2')



r.router(rootElm, defaultRoute, routesHash)

Takes DOM Element rootElm and mounts routes according to components in routesHash as with m.route(elm, default, routes). defaultRoute can be seen as an error state as this is where the router will navigate to if there is not match found in routesHash.

Routes can contain :param and * splats. See http-hash for details.

Stack methods

r.push(url, state)

Push a new history entry. Allows to pass a state object as well which is persisted to the history stack. Note that this state element may be 600B serializes at most.

r.replace(url, state)

Replace the current History entry and redraw


Equivalent to pressing back


Return {url, state}


r.anchor(state, operation)

Similar to {config: m.route} except it allows you to pass a state object and choose how the browser navigates using one of the stack methods. Defaults to r.push. state is passed to the operation.


Return the current window.history.state or null


Return a object with the current path parameters or null


Return the current splat or null

Current Tags

  • 0.0.3                                ...           latest (5 years ago)

4 Versions

  • 0.0.3                                ...           5 years ago
  • 0.0.2                                ...           5 years ago
  • 0.0.1                                ...           5 years ago
  • 0.0.0                                ...           5 years ago
Maintainers (1)
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 1
Last Month 0
Dependencies (1)
Dev Dependencies (2)
Dependents (0)

Copyright 2014 - 2016 © |