react-router 6.2.2 → 6.4.0-pre.10

package/CHANGELOG.md

@@ -0,0 +1,134 @@
+# react-router
+
+## 6.4.0-pre.10
+
+### Patch Changes
+
+- feat: Deferred API Updates (#9070)
+
+  - Removes `<Suspense>` from inside `<Deferred>`, requires users to render their own suspense boundaries
+  - Updates `Deferred` to use a true error boundary to catch render errors as well as data errors
+  - Support array and single promise usages
+    - `return deferred([ await critical(), lazy() ])`
+    - `return deferred(lazy())`
+  - Remove `Deferrable`/`ResolvedDeferrable` in favor of raw `Promise`'s and `Awaited`
+  - Remove generics from `useDeferredData` until `useLoaderData` generic is decided in 6.5
+
+- Updated dependencies
+  - @remix-run/router@0.2.0-pre.5
+
+## 6.4.0-pre.9
+
+### Patch Changes
+
+- Feat: adds `deferred` support to data routers (#9002)
+
+  Returning a `deferred` from a `loader` allows you to separate _critical_ loader data that you want to wait for prior to rendering the destination page from _non-critical_ data that you are OK to show a spinner for until it loads.
+
+  ```jsx
+  // In your route loader, return a deferred() and choose per-key whether to
+  // await the promise or not.  As soon as the awaited promises resolve, the
+  // page will be rendered.
+  function loader() {
+    return deferred({
+      critical: await getCriticalData(),
+      lazy: getLazyData(),
+    });
+  };
+
+  // In your route element, grab the values from useLoaderData and render them
+  // with <Deferred>
+  function DeferredPage() {
+    let data = useLoaderData();
+    return (
+      <>
+        <p>Critical Data: {data.critical}</p>
+        <Suspense fallback={<p>Loading...</p>}>
+          <Deferred value={data.lazy} errorElement={<RenderDeferredError />}>
+            <RenderDeferredData />
+          </Deferred>
+        </Suspense>
+      </>
+    );
+  }
+
+  // Use separate components to render the data once it resolves, and access it
+  // via the useDeferredData hook
+  function RenderDeferredData() {
+    let data = useDeferredData();
+    return <p>Lazy: {data}</p>;
+  }
+
+  function RenderDeferredError() {
+    let data = useRouteError();
+    return <p>Error! {data.message} {data.stack}</p>;
+  }
+  ```
+
+  If you want to skip the separate components, you can use the Render Props
+  pattern and handle the rendering of the deferred data inline:
+
+  ```jsx
+  function DeferredPage() {
+    let data = useLoaderData();
+    return (
+      <>
+        <p>Critical Data: {data.critical}</p>
+        <Suspense fallback={<p>Loading...</p>}>
+          <Deferred value={data.lazy} errorElement={<RenderDeferredError />}>
+            {(data) => <p>{data}</p>}
+          </Deferred>
+        </Suspense>
+      </>
+    );
+  }
+  ```
+
+- feat: add basename support for data routers (#9026)
+- fix: Fix trailing slash behavior on pathless routing when using a basename (#9045)
+- Updated dependencies
+  - @remix-run/router@0.2.0-pre.4
+
+## 6.4.0-pre.8
+
+### Patch Changes
+
+- fix: Make path resolution trailing slash agnostic (#8861)
+- fix: Additional logic fixed for relative navigation from index/pathless layout routes (#8985)
+- fix: export ActionFunctionArgs/LoaderFunctionArgs up through router packages (#8975)
+- Updated dependencies
+  - @remix-run/router@0.2.0-pre.3
+
+## 6.4.0-pre.7
+
+### Minor Changes
+
+- Add support for functional updates in `useSearchParams` (similar to the `useState` callback signature) (#8955)
+
+### Patch Changes
+
+- Properly handle relative navigation from index/pathless routes (#8954)
+- Fix issues building with webpack + React 17 (#8938)
+- Updated dependencies
+  - `@remix-run/router@0.2.0-pre.2`
+
+## 6.4.0-pre.6
+
+## 6.4.0-pre.5
+
+### Patch Changes
+
+- Fix broken require for CJS builds
+
+## 6.4.0-pre.4
+
+### Patch Changes
+
+- Fix missing `dist` files
+
+## 6.4.0-pre.3
+
+### Patch Changes
+
+- Make `fallbackElement` optional and change type to `ReactNode` (type changes only) (#8896)
+- Properly trigger error boundaries on 404 routes

package/LICENSE.md

@@ -1,7 +1,7 @@
 MIT License
 
 Copyright (c) React Training 2015-2019
-Copyright (c) Remix Software 2020-2021
+Copyright (c) Remix Software 2020-2022
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import type { ActionFunction, ActionFunctionArgs, DataRouteMatch, Fetcher, JsonFunction, LoaderFunction, LoaderFunctionArgs, Location, Navigation, Params, ParamParseKey, Path, PathMatch, PathPattern, RedirectFunction, RouteMatch, RouteObject, ShouldRevalidateFunction, To } from "@remix-run/router";
+import { Action as NavigationType, createPath, deferred, generatePath, isDeferredError, isRouteErrorResponse, json, matchPath, matchRoutes, parsePath, redirect, resolvePath } from "@remix-run/router";
+import type { DataMemoryRouterProps, DeferredProps, MemoryRouterProps, NavigateProps, OutletProps, RouteProps, PathRouteProps, LayoutRouteProps, IndexRouteProps, RouterProps, RoutesProps } from "./lib/components";
+import { createRoutesFromChildren, renderMatches, DataMemoryRouter, DataRouter, DataRouterProvider, Deferred, MemoryRouter, Navigate, Outlet, Route, Router, Routes } from "./lib/components";
+import type { Navigator, NavigateOptions } from "./lib/context";
+import { DataRouterContext, DataRouterStateContext, DataStaticRouterContext, LocationContext, NavigationContext, RouteContext } from "./lib/context";
+import type { NavigateFunction } from "./lib/hooks";
+import { useHref, useInRouterContext, useLocation, useMatch, useNavigationType, useNavigate, useOutlet, useOutletContext, useParams, useResolvedPath, useRoutes, useActionData, useDeferredData, useLoaderData, useMatches, useRouteLoaderData, useRouteError, useNavigation, useRevalidator } from "./lib/hooks";
+declare type Hash = string;
+declare type Pathname = string;
+declare type Search = string;
+export type { ActionFunction, ActionFunctionArgs, DataMemoryRouterProps, DataRouteMatch, DeferredProps, Fetcher, Hash, IndexRouteProps, JsonFunction, LayoutRouteProps, LoaderFunction, LoaderFunctionArgs, Location, MemoryRouterProps, NavigateFunction, NavigateOptions, NavigateProps, Navigation, Navigator, OutletProps, Params, ParamParseKey, Path, PathMatch, Pathname, PathPattern, PathRouteProps, RedirectFunction, RouteMatch, RouteObject, RouteProps, RouterProps, RoutesProps, Search, ShouldRevalidateFunction, To, };
+export { DataMemoryRouter, Deferred, MemoryRouter, Navigate, NavigationType, Outlet, Route, Router, Routes, createPath, createRoutesFromChildren, deferred, isDeferredError, isRouteErrorResponse, generatePath, json, matchPath, matchRoutes, parsePath, redirect, renderMatches, resolvePath, useActionData, useDeferredData, useHref, useInRouterContext, useLoaderData, useLocation, useMatch, useMatches, useNavigate, useNavigation, useNavigationType, useOutlet, useOutletContext, useParams, useResolvedPath, useRevalidator, useRouteError, useRouteLoaderData, useRoutes, };
+/** @internal */
+export { DataRouter as UNSAFE_DataRouter, DataRouterProvider as UNSAFE_DataRouterProvider, NavigationContext as UNSAFE_NavigationContext, LocationContext as UNSAFE_LocationContext, RouteContext as UNSAFE_RouteContext, DataRouterContext as UNSAFE_DataRouterContext, DataRouterStateContext as UNSAFE_DataRouterStateContext, DataStaticRouterContext as UNSAFE_DataStaticRouterContext, };