tiaanduplessis/rout3r

Trie based React Router in under 1 KB

Trie based React Router in under 1 KB

Table of Contents

• Table of Contents
• About
• Install
• Usage
• Contribute
• License

About

• Uses Context API and wayfarer for fast routing.
• Tiny footprint (Less than 1 KB gzipped)
• Configurable via history

Install

This project uses node and npm.

$ npm install rout3r
$ # OR
$ yarn add rout3r

Usage

import React from "react";
import ReactDOM from "react-dom";
import { Router, Link } from "rout3r";

const PageOne = () => (
  <h2>
    Page 1 <Link href="/tiaan?hello=person">go to</Link>
  </h2>
);
const PageTwo = props => (
  <h2>
    Page 2 {props.params.ahhhhh} {JSON.stringify(props.searchParams)}
  </h2>
);

const PageThree = props => <h2>Page 3</h2>;

const PageFour = props => <h2>Page 4</h2>;

function App() {
  return (
    <Router defaultPath="/404">
      <PageOne path="/" />
      <PageThree path="/foo" />
      <PageFour path="/foo/bar" />
      <PageTwo path="/:ahhhhh" />
    </Router>
  );
}

const rootElement = document.getElementById("root");
ReactDOM.render(<App />, rootElement);

Contribute

1. Fork it and create your feature branch: git checkout -b my-new-feature
2. Commit your changes: git commit -am "Add some feature"
3. Push to the branch: git push origin my-new-feature
4. Submit a pull request

License

MIT

rout3r's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.