riot-route

Simple isomorphic router

Usage no npm install needed!

<script type="module">
  import riotRoute from 'https://cdn.skypack.dev/riot-route';
</script>

README

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 index.js npm
ES module Rollup lib/index.js npm

jsdelivr

<script src="https://cdn.jsdelivr.net/npm/riot-route@x.x.x/dist/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 riot.js.org.

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