npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@unibuddy/react-relative-router

v0.7.0

Published

A wrapper for react-router that enables relative routes within a bounded context

Downloads

9

Readme

React Relative Router

A wrapper for react-router that enables relative routes within a bounded context

Install

npm install @unibuddy/react-relative-router

yarn add @unibuddy/react-relative-router

Exports

import {
  useRelativeRouter,
  RelativeRoute,
  RelativeSwitch,
  RelativeLink,
  RelativeNavLink,
  RelativeRouter,
  RelativeRedirect,
} from '@unibuddy/react-relative-router';

Example Use

Basic example

import { BrowserRouter, Route } from 'react-router-dom';
import { RelativeRouter, RelativeRoute } from '@unibuddy/react-relative-router';

const App = () => {
  return (
    <BrowserRouter>
      <Route path="/some/long/route">
        <RelativeRouter>
          <RelativeRoute path="/test">
            This will only render when you navigate to `/some/long/route/test`
          </RelativeRoute>
        </RelativeRouter>
      </Route>
      <Route path="/with/:params">
        <RelativeRouter>
          <RelativeRoute path="/test">
            It will also preserve params in urls. You can use `useParams` within
            this context to access params of the top level route.
          </RelativeRoute>
        </RelativeRouter>
      </Route>
    </BrowserRouter>
  );
};

Linking

import { BrowserRouter, Route } from 'react-router-dom';
import {
  RelativeRouter,
  RelativeRoute,
  RelativeLink,
} from '@unibuddy/react-relative-router';

const App = () => {
  return (
    <BrowserRouter>
      <Route path="/some/long/route">
        <RelativeRouter>
          <RelativeRoute path="/test">
            <RelativeLink to="/some-route">Go to sibling route</RelativeLink>
          </RelativeRoute>
          <RelativeRoute path="/some-route">Sibling route</RelativeRoute>
        </RelativeRouter>
      </Route>
    </BrowserRouter>
  );
};

Switch and redirects

import { BrowserRouter, Route } from 'react-router-dom';
import {
  RelativeRouter,
  RelativeRoute,
  RelativeLink,
  RelativeRedirect,
} from '@unibuddy/react-relative-router';

const App = () => {
  return (
    <BrowserRouter>
      <Route path="/some/long/route">
        <RelativeRouter>
          <RelativeSwitch>
            <RelativeRoute path="/home">Home</RelativeRoute>
            <RelativeRoute path="/">
              {/* catch all redirect */}
              <RelativeRedirect to="/home" />
            </RelativeRoute>
          </RelativeSwitch>
        </RelativeRouter>
      </Route>
    </BrowserRouter>
  );
};

Use with other components

import { Link } from 'react-router-dom';
import { useRelativeRouter } from '@unibuddy/react-relative-router';

const MyComponent = () => {
  const { url, path, getTo, getPath } = useRelativeRouter();
  return (
    <>
      {/* use the helper methods */}
      <Link to={getTo('/relative-route')}>Go to relative route</Link>
      <Route path={getPath('/relative-route')}>Relative route</Route>
      {/* or use the raw values */}
      <Link to={`${url}/relative-route`}>Go to relative route</Link>
      <Route path={`${path}/relative-route`}>Relative route</Route>
    </>
  );
};