Giter VIP home page Giter VIP logo

react-router-typesafe's Introduction

React Router Typesafe

React Router Typesafe is a minimal (235 bytes gzipped) patch built upon react-router to add type-safety via the use of generics. It brings type functionality closer to Remix, the full-stack framework from the same authors.

Getting Started

Install the package:

npm install react-router-typesafe

Replace your imports from react-router to react-router-typesafe:

- import { defer, useLoaderData, useActionData } from "react-router";
+ import { defer, useLoaderData, useActionData } from "react-router-typesafe";

Usage

useLoaderData / useActionData

import { useLoaderData, useActionData, LoaderFunction, ActionFunction } from 'react-router-typesafe';

const loader = (() => ({ message: 'Hello World' })) satisfies LoaderFunction;

const action = (() => ({ ok: true })) satisfies ActionFunction;

const Component = () => {
	const data = useLoaderData<typeof loader>();
	const actionData = useActionData<typeof action>();

	return <div>{data.message}</div>;
};

Warning Do not annotate the type of the loader/action function. It will break the type-safety. Instead rely on either the satisfies keyword from Typescript 4.9 onwards, or the makeLoader / makeAction utilities proveded by this library.

Utilities

makeLoader / makeAction

The makeLoader and makeAction utils replace the need for the satisfies keyword without adding any runtime overhead.

import { makeLoader, makeAction } from 'react-router-typesafe';

const loader = makeLoader(() => ({ message: 'Hello World' }));

const action = makeAction(() => ({ ok: true }));

typesafeBrowserRouter ❇️ NEW

The typesafeBrowserRouter is a wrapper around createBrowserRoute that returns a href function in addition to the routes.

It’s easy to incrementally adopt, and you can use href anywhere, not just in <Link> components.

Set up your routes like this:

- import { createBrowserRouter } from "react-router-dom";
+ import { typesafeBrowserRouter } from "react-router-typesafe";

- export const router = createBrowserRouter([
+ export const { router, href } = typesafeBrowserRouter([
  { path: "/", Component: HomePage },
  { path: "/projects/:projectId", Component: ProjectPage },
]);
  • ✅ No need to change your existing <Link> components.
  • ✅ URL params are inferred and type-checked.
  • ✅ Supports query params and URL hash
  • ✅ Refactor-friendly: Rename Symbol on the route path and it’ll be updated everywhere.

Then use href to generate URLs:

import { Link } from 'react-router-dom';
import { href } from './router';

const ProjectCard = (props: { id: string }) => {
	return (
		<Link to={href({ path: '/projects/:projectId', params: { projectId: props.id } })}>
			<p>Project {projectId}</p>
		</Link>
	);
};

Contributing

Feel free to improve the code and submit a pull request. If you're not sure about something, create an issue first to discuss it.

Functions

Status Utility Before After
defer Response Generic matching the first argument
json Response Serialized data passed in
useLoaderData unknown Generic function with the type of the loader function passed
useActionData unknown Generic function with the type of the action function passed
useRouteLoaderData unknown Generic function with the type of the loader function passed
NEW makeLoader Wrapper around satisfies for ergonomics
NEW makeAction Wrapper around satisfies for ergonomics
NEW typesafeBrowserRouter Extension of createBrowserRouter

Patched components

Status Component Before After
<Await> children render props would be typed as any Generic component makes render props typesafe

About

React Router is developed and maintained by Remix Software and many amazing contributors.

react-router-typesafe's People

Contributors

fredericoo avatar github-actions[bot] avatar jvmusin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

react-router-typesafe's Issues

Data not resolved correctly

I have a route that has a nested route.
They both have loaders, and when I try to access the parent route data, I get the child loader data, regardless of the ID that I pass.

    {
      path: '/', // Base URL, here we serve the application. All the other URLs are nested underneath and define their own paths that append to the base URL
      loader: currentUserLoader,
      element: <App />,
      id: 'currentUser',
      children: [
        {
          loader: qualificationsLoader,
          path: `/qualifications`,
...
}
const currentUser = useRouteLoaderData<typeof currentUserLoader>('currentUser');
// Types are correct, but it returns qualifications, not the currentUser

How to get errors without response type for useActionData

Hello & thank you for creating this library, its been a blessing.

Just wondering how I can best get the errors that are returned from my useActionData hook if the action had also had a redirect for successful use cases?

For example, here is the type I see in that case:

const actionData: ActionData<({request}: ActionFunctionArgs<any>) => Promise<Response | {status: number, error: string}>>

Coming from this relevant code:

const actionData = useActionData<typeof contactAction>()
export const contactAction = makeAction(async ({request}: ActionFunctionArgs) => {
  const data = await request.formData()
  const submission = {
      email: data.get('email') as string,
      message: data.get('message') as string
  }

  if(submission.message.length < 10) {
      return {
          status: 400,
          error: 'Your message must be at least 10 characters long.'
      }
  }

  return redirect('/')
})

If my understanding is correct, the component will never "see" the Response anyways, so it can be omitted? Thanks in advance.

Cannot use defer on a loader with typesafeBrowserRouter

I have a loader with defer:

import { defer } from 'react-router-typesafe';
...

export const dashboardLoader = (queryClient: QueryClient) => () => {
  return defer<{
    dashboardInfo: Promise<DashboardType>;
  }>({
    dashboardInfo: queryClient.ensureQueryData(dashboardInfoQueries.info()),
  });
};

and I have a RouteObject like this in typesafeBrowserRouter:

{
   index: true,
   loader: dashboardLoader(queryClient),
   async lazy() {
         const { Dashboard } = await import('@/views/dashboard/Dashboard');

         return { element: <Dashboard /> };
   },
},

I get an error: Type () => DeferredData<{ dashboardInfo: Promise<DashboardType>; }> is not assignable to type NarrowKeys<boolean | LoaderFunction<any> | undefined>

This doesn't happen when I am using a regular loader without defer.

Oh, and when I just switch from typesafeBrowserRouter to createBrowserRouter everything works just fine since then, loader doesn't have that NarrowKeys type.

Error with loader returning json

I am following the 30 minute Remix tutorial and have this code that uses your library:

import { LoaderFunction, useLoaderData } from "react-router-typesafe";
import { json } from "@remix-run/node";
import { getContacts } from "./data";

export const loader = (async () => {
  const contacts = await getContacts();
  return json({ contacts });
}) satisfies LoaderFunction;

export default function App() {
  const { contacts } = useLoaderData<typeof loader>();
}

The useLoaderData line has this error:
Property 'contacts' does not exist on type 'Omit<Response, "json"> & { json(): Promise<{ contacts: ContactRecord[]; }>; }'.

What am I doing wrong?

href path not recognize children path from route object declare outside typesafeBrowserRouter

this is my typesafeBrowserRouter:

export const { router, href } = typesafeBrowserRouter([
  {
    path: "/",
    element: <AppLoading />,
  },
  {
    path: "app",
    children: AppRoutes,
  },
]);

AppRoutes is a simple RouteObject[] as follow:

const AppRoutes: RouteObject[] = [
  {
    index: true,
    async lazy() {
      const { Home } = await import("../pages");
      return { Component: Home };
    },
  },
  {
    path: "contact",
    async lazy() {
      const { Contact } = await import("../pages");
      return {
        element: <ProtectedRoute children={<Contact />} />,
      };
    },
  },
];

when using href it doesn't recognize "/app/contact" as a route it's only options are "/"|"app"
<NavLink to={href({ path: "app/contact", })}>contact page</NavLink>
error:

Type '"app/contact"' is not assignable to type '"/" | "app"'

I would love to know if there is a way to fix this other than setting everything inside the typesafeBrowserRouter

How about adding the support for the "useRouteLoaderData" as well?

I have a use case where a deeply nested component need access to the data defined in the loader, and for that we need the hook useRouteLoaderData, which this library does not currently support.

Is this something you are willing to add?

I am at version 1.3.0, and while I can see it in the source code, it is not being exported for consumption.
https://github.com/stargaze-co/react-router-typesafe/blob/2a25b3ed19602913d5fdfba19907ef65005d01e9/src/loader.ts#L20C14-L20C32

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.