Module "router-helper/index"

example

import createRouteMatcher from "feather-route-matcher";
import queryString from "query-string"; // only if using query strings

const Route = createRouteSegments([...]);

const routeConfig = { ... };

const router = createFeatherRouter({
  createRouteMatcher,
  routeConfig,
  defaultRoute: [Route.Home()],
  queryString // only if using query strings
});

example

import m from "mithril";
// Note: query strings are built-in to Mithril

const Route = createRouteSegments([...]);

const routeConfig = { ... };

const router = createMithrilRouter({
  m,
  routeConfig
});

To use this function, write a createXYZRouter function that in turn calls createRouter. All config parameters except for createParsePath are normally passed-thru from createXYZRouter to createRouter, unless you want to define specific implementations of getPath, setPath, and/or addLocationChangeListener.

The key parse is createParsePath. This is where you define how to plug in to the router library of your choice.

function createParsePath(routeMap, defaultRoute) receives a routeMap which is an object with

example

// Example of a createParsePath function with feather-route-matcher
const createParsePath = (routeMap, defaultRoute) => {
  const routeMatcher = createRouteMatcher(routeMap);

  const parsePath = (path, queryParams) => {
    const match = routeMatcher(path);

    if (match) {
      return match.value(Object.assign({}, match.params, queryParams));
    } else {
      return defaultRoute;
    }
  };
  return parsePath;
};

example

import Mapper from "url-mapper";
import urlon from "urlon"; // only if using query strings

const Route = createRouteSegments([...]);

const routeConfig = { ... };

const router = createUrlMapperRouter({
  Mapper,
  routeConfig,
  defaultRoute: [Route.Home()],
  queryString: urlon // only if using query strings
});