Get unlimited public & private packages + team-based management with npm Teams.Learn more »

react-router-relative

1.0.0 • Public • Published

react-router-relative-link

Build Status

A wrapper around react-router's Link and LinkIndex that allows relative paths.

Original repo: https://github.com/donavon/react-router-relative-link

Install

> npm i react-router-relative-link --save

Usage

To use react-router-relative-link, simply import it (ES6) as Link in place of react-router then dot and dot-dot to your heart's content.

So in your code, replace this:

import { Link } from "react-router";

with the following and you're good to go!

import { Link } from "react-router-relative-link";

Here is a real world example. Notice that you don't need to know that you are at the base base /zoo, just like everywhere else in web land.

import { Link } from "react-router-relative-link";
 
export default class MyZoo extends React.Component {
    render() {
        return (
            <p>Welcome to the Lions Den at /zoo/lions</p>
            <Link to="..">Back to the Zoo Entrance</Link>
            <Link to="../giraffes">Visit the Giraffes</Link>
            <Link to="../monkeys">Visit the Monkeys</Link>
            <Link to="mountain">Visit the Mountain Lions</Link>
        );
    }
}

react-router-relative-link support passing to as a string or as an object with a pathname property, just like react-router.

It also works with both Link and with LinkIndex.

FAQ

Where does it get the current path?

You have two options.

  1. Pass it in a property named currentPath. This is the current, or base path on which the relative pathname will be based.

  2. If you don't specify currentPath, it will pull the information from window.location.hash.

Does it Work?

Of course it does, and I have the tests to prove it! See the test results here.

Install

npm i react-router-relative

DownloadsWeekly Downloads

3

Version

1.0.0

License

MIT

Last publish

Collaborators

  • avatar