router5 editorconfig eslint travis-ci Bower npm

Flexible and powerful routing solution

npm version Build Status Coverage Status Join the chat at https://gitter.im/router5/router5

Official website: router5.github.io

router5

A simple, powerful, modular and extensible router, organising your named routes in a tree and handling route transitions. In its simplest form, router5 processes routing instructions and outputs state updates.

router5 is library and framework agnostic, works universaally, and makes no asumption on your implementation. It favours convention over configuration, by giving you the means to observe route changes and to react to them. Afterall, why treat route changes any different than data changes?

To get started, look here: Understanding router5 and Get started.

import createRouter from 'router5';
import browserPlugin from 'router5/plugins/browser';

const routes = [
    { name: 'home', '/home' },
    { name: 'profile', '/profile' }
];

const router = createRouter(routes)
    .usePlugin(browserPlugin());

v4.0.0

Version 4 is a refactor of router5, some of the API has slightly changed: release notes are available

Flexible

router5 offers two essential tools: middlewares and plugins.

-Middlewares allow you to decide the fate of a transition: you can delay it while performing asynchronous operations (data loading), fail it or simply hook some custom business logic. - Plugins are perfect for side-effects and 3rd party integration, by allowing you to react to router events: when it starts or stops, when a transition starts, is successful, has failed or has been cancelled. You can use them for updating the page title in the browser, sending page view analytic events, creating observables, sending your router state to a data store, etc…

Features

  • Default start route: a default route to navigate to on load if the current URL doesn’t match any route. Similar to $routeProvider.otherwise() in Angular ngRoute module.
  • Unknown routes: if redirects to a default route is not how you want to handle unknown routes, router5 can generate state objects for them instead.
  • Start and stop
  • Nested named routes: routes are identified by names and path (containing parameters) so you don’t have to manipulate URLs, even query parameters don’t need to be specified on leaves only. directly. Routes can be nested, introducing the notion of route segments.
  • Segments activation: you can control whether or not a route can be accessed by specifying a canActivate function per node. Supports asynchronous results.
  • Segments deactivation: you can register segment components. On a route change, it will ask those components through their canDeactivate method if they allow navigation. Similar to Angular 2 and Aurelia routers. Supports asynchronous results.
  • Custom plugins: extend your router behaviour with custom plugins
  • Middleware functions: handle any data updates or other asynchronous actions with multiplebefore updating your view.
  • Universal applications: use on client and server side
  • Redirections: redirect to another route on error
  • You are in control! You decide what to do on a route change and how to do it.

Plugins

Several plugins are available in this repository:

  • Listeners plugin: allows you to add various types of route change listeners.
  • Browsers plugin: use of hash or not, URL building, HTML5 history integration.
  • Persistent parameters plugin: allows some query parameters to persist and survive navigation, without having to manually specify them for each transition.
import browserPlugin from 'router/plugins/browser';
import listenersPlugin from 'router/plugins/listeners';
import persistentParamsPlugin from 'router/plugins/persistentParams';

Guides

API

Examples

Integration

Contributing

Please read contributing guidelines.

Related

Related Repositories

router5

router5

Flexible and powerful routing solution ...

redux-router5

redux-router5

Router5 integration with redux ...

react-router5

react-router5

Helpers for using router5 with React ...

cycle-router5

cycle-router5

A router driver for Cycle.js, wrapping the router5 library ...

deku-router5

deku-router5

Helpers for using router5 with Deku ...


Top Contributors

troch JonathanWolfe micha149 jwoudenberg pedrosland gitter-badger

Releases

-   v4.3.0 zip tar
-   v4.2.3 zip tar
-   v4.2.2 zip tar
-   v4.2.1 zip tar
-   v4.2.0 zip tar
-   v4.1.1 zip tar
-   v4.1.0 zip tar
-   v4.0.5 zip tar
-   v4.0.4 zip tar
-   v4.0.3 zip tar
-   v4.0.2 zip tar
-   v4.0.1 zip tar
-   v4.0.0 zip tar
-   v3.0.3 zip tar
-   v3.0.2 zip tar
-   v3.0.1 zip tar
-   v3.0.0 zip tar
-   v2.0.6 zip tar
-   v2.0.5 zip tar
-   v2.0.4 zip tar
-   v2.0.3 zip tar
-   v2.0.2 zip tar
-   v2.0.1 zip tar
-   v2.0.0 zip tar
-   v2.0.0-rc.1 zip tar
-   v1.4.0 zip tar
-   v1.3.0 zip tar
-   v1.2.2 zip tar
-   v1.2.1 zip tar
-   v1.2.0 zip tar