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

@uplift-ltd/nextjs-use-react-navigation

v4.0.0

Published

nextjs-use-react-navigation

Downloads

7

Readme

@uplift-ltd/nextjs-use-react-navigation

Installation

npm i --save @uplift-ltd/nextjs-use-react-navigation

API

useRouterNavigation

Exposes stable methods for the navigation methods of NextJS router

import { useRouterNavigation } from "@uplift-ltd/nextjs-use-react-navigation";

export default function MyComponent() {
  const { back, push, replace } = useRouterNavigation();

  const goToProfile = useCallback(() => {
    return push("/profile");
  }, [push]);

  const goToProfileReplaced = useCallback(() => {
    return replace("/profile");
  }, [replace]);

  return (
    <div>
      <button type="button" onClick={back}>
        Go Back
      </button>
      <button type="button" onClick={goToProfile}>
        Go to Profile
      </button>
      <button type="button" onClick={goToProfileReplaced}>
        Go to Profile, replaced
      </button>
    </div>
  );
}

useRouterQuery

Nice way of accessing type-safe router.params. By default, the type is narrowed to returning string | undefined instead of the next.js default of string[] | string | undefined. This makes it a bit nicer to use, avoiding the need for checking if the variable is string[].

const Component = () => {
  const { routerQuery } = useRouterQuery();

  const { foo, bar } = routerQuery;
  // routerQuery is essentially Record<string, string | undefined>
  // typeof foo => string | undefined
  // typeof bar => string | undefined
};

You can also pass in a type shape, useful if you expect a key to be an array after all.

type ParamType = {
  foo: string;
  bar: string;
  baz: string[];
  count: number;
};

const Component = () => {
  const { routerQuery } = useRouterQuery<ParamType>();

  const { foo, bar, baz, count, other } = routerQuery;
  //                            ^^^ Error here, 'other' is not defined on ParamType
  // typeof foo => string | undefined
  // typeof bar => string | undefined
  // typeof baz => string[] | undefined
  // typeof count => string | undefined
  // NOTE: ^^^ number gets converted to string because URL params are not parsed
};

You can pass in a string union as a convenience when you only expect params to be of string, but want to type-check access

const Component = () => {
  const { routerQuery } = useRouterQuery<"foo" | "bar" | "count">();

  const { foo, bar, count, other } = routerQuery;
  //                       ^^^ Error here, 'other' is not defined on our union
  // typeof foo => string | undefined
  // typeof bar => string | undefined
  // typeof count => string | undefined
};

useRouterQueryForUrl

An enhanced useRouterQuery hook that looks at your URL and adds the URL param tokens as required keys in the returned object, and allows you to specify the possible query params that might be passed as well. The second type argument functions exactly as the initial type argument found on useRouterQuery.

const USER_DETAIL_URL = "/teams/:teamId/users/:userId";

const Component = () => {
  const { routerQuery } = useRouterQueryForUrl<typeof USER_DETAIL_URL, "foo" | "bar">();

  const { teamId, userId, foo, bar } = routerQuery;
  // typeof teamId => string
  // typeof userId => string
  // typeof foo => string | undefined
  // typeof bar => string | undefined
};

Or, with a more complex type shape

const USER_DETAIL_URL = "/teams/:teamId/users/:userId";

type ParamType = {
  foo: string;
  bar: string;
  baz: string[];
  count: number;
};

const Component = () => {
  const { routerQuery } = useRouterQueryForUrl<typeof USER_DETAIL_URL, ParamType>();

  const { teamId, userId, foo, bar, baz, count, other } = routerQuery;
  //                            ^^^ Error here, 'other' is not defined on ParamType
  // typeof teamId => string
  // typeof userId => string
  // typeof foo => string | undefined
  // typeof bar => string | undefined
  // typeof baz => string[] | undefined
  // typeof count => string | undefined
  // NOTE:  ^^^ number gets converted to string because URL params are not parsed
};