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

react-use-path

v0.3.2

Published

The tiniest react router implemented with hooks.

Downloads

240

Readme

react-use-path

NPM version Build Status Test Coverage Dependency Status DevDependency Status License PR Welcome

The tiniest react router implemented with hooks.

Introduction

The React brand new feature hooks changes the way how we write and organize components. Writing an app fully with functional components becomes possible. The first thing I'd like to try is to replace the heavy react-router, and create a simple yet powerful functional router.

Finally the API really stunned me.

const [path, setPath] = usePath();

It can't be more simple yet powerful. It makes the coding style of an app looks more pure functional and consistent.

Installation

Install this package with npm.

npm i react-use-path -s

Usage

Use javaScript language level switch.

import React from 'react';
import usePath from 'react-use-path';

const App = () = {
  const [path, setPath] = usePath();
  switch (path.path) {
    case '/':
      return <HomePage />;
    case '/products':
      return <ProductListPage />;
    case '/profile':
      return <UserPage />;
    default:
      return <PageNotFound />;
  }
}

Use your own switch. You should find a package that implements these components or implement your own.

import React from 'react';
import usePath from 'react-use-path';

const App = () = {
  const [path, setPath] = usePath();
  return <Switch value={path.path}>
    <Case value='/'>
      <HomePage />
    </Case>
    <Case value='/products'>
      <ProductsPage />
    </Case>
    <Case value='/profile'>
      <UserPage />
    </Case>
    </Default>
      <PageNotFound />
    </Default>
  </Switch>;
}

Use your own router component. You should find a package that implements these components or write your own.

import React from 'react';
import usePath from 'react-use-path';

const App = () = {
  const [path, setPath] = usePath();
  return <Router location={path.fullpath} setLocation={setPath}>
    <Route match='/'>
      <HomePage />
    </Route>
    <Route match='/products'>
      <ProductsPage />
    </Route>
    <Route match='/products/:id'>
      <ProductPage />
    </Route>
    <Route match='/profile'>
      <UserPage />
    </Route>
    </Route match='*'>
      <PageNotFound />
    </Route>
  </Router>;
}

Redirection is just a line of code.

import React from 'react';
import usePath from 'react-use-path';

const App = () = {
  const currentUser = useUser();
  const [path, setPath] = usePath();
  if (!currentUser) {
    return setPath('/sign-in');
  }
  return <div>...</div>;
}

API

path

path is an object which contains 4 values. Let's say, the current url is http://www.example.com/part1/part2?val1=2&val2=5#top. The path value is:

{
  "path": "/part1/part2;",
  "query": "val1=2&val2=5",
  "hash": "top",
  "fullpath": "/part1/part2?val1=2&val2=5#top"
}

setPath

  • setPath(path: string)

Set new path value with a full path string.

setPath('/foo/bar?baz=true'); // => '/foo/bar?baz=true'
  • setPath(path: object)

Set new path component with an object.

setPath({ hash: 'bottom' }) // => '/foo/bar?baz=true#bottom'
setPath({ query: 'baz=false' }) // => '/foo/bar?baz=false'
setPath({ path: '/another/path' }) // => '/another/path'
setPath({
  path: '/user',
  query: 'hidePassword=true'
}) // => '/user?hidePassword=true'

License

MIT © Victor Teo