Simple client-side router
JavaScript HTML
Latest commit 78aa55e Dec 3, 2016 @cognitom cognitom 3.0.2
Permalink
Failed to load latest commit information.
dist Closes #77 Dec 3, 2016
doc Refactor documents Nov 23, 2016
lib Fix #74 Nov 29, 2016
test Fix #74 Nov 29, 2016
.codeclimate.yml ignore the dist folder on codeclimate Aug 19, 2015
.editorconfig wip Aug 13, 2015
.eslintrc.json Fix test settings Nov 22, 2016
.gitignore added: es6 version Nov 9, 2015
.travis.yml Migration from makefile to npm scripts Nov 22, 2016
LICENSE Initial commit Jun 6, 2015
README.md Refactor documents Nov 23, 2016
bower.json router --> route Aug 19, 2015
package.json 3.0.2 Dec 3, 2016
rollup.js Closes #77 Dec 3, 2016

README.md

Riot Router

Build Status Code Quality NPM version NPM downloads MIT License Coverage Status

Simple client-side router

The Riot Router is the minimal router implementation with such technologies:

  • pushState and history API
  • multiple routing groups
  • replacable parser
  • compatible with IE9 and higher

It started as a part of Riot.js, but now it becomes an independent library. It works with or without Riot.js.

Table of Contents

Install

We have 4 editions:

edition target file via
Standalone <script> tag dist/route.min.js jsdelivr ⋅ Bower ⋅ download
AMD RequireJS dist/amd.route.min.js jsdelivr ⋅ Bower ⋅ download
CommonJS Browserify, webpack dist/cjs.route.js npm
ES module Rollup lib/index.js npm

jsdelivr

<script src="https://cdn.jsdelivr.net/riot-route/x.x.x/route.min.js"></script>

Note: change the part x.x.x to the version numbers what you want to use: ex. 2.5.0 or 3.0.0.

npm

$ npm install --save riot-route

Bower

$ bower install --save riot-route

Download by yourself

Usage

See also riotjs.com.

Demos

Contribute

Feel free to dive in! Open an issue or submit PRs.

  • $ npm install to setup
  • $ npm run build to build it once
  • $ npm run watch to watch and build it continuously
  • $ npm test to test

License

MIT (c) Muut, Inc. and other contributors