react-router
Advanced tools
Comparing version 0.0.0-experimental-65d6b8c9 to 0.0.0-experimental-6844c5934
646
CHANGELOG.md
# `react-router` | ||
## 7.1.1 | ||
## 7.1.0 | ||
### Patch Changes | ||
- Throw unwrapped single fetch redirect to align with pre-single fetch behavior ([#12506](https://github.com/remix-run/react-router/pull/12506)) | ||
- Ignore redirects when inferring loader data types ([#12527](https://github.com/remix-run/react-router/pull/12527)) | ||
- Remove `<Link prefetch>` warning which suffers from false positives in a lazy route discovery world ([#12485](https://github.com/remix-run/react-router/pull/12485)) | ||
## 7.0.2 | ||
### Patch Changes | ||
- temporarily only use one build in export map so packages can have a peer dependency on react router ([#12437](https://github.com/remix-run/react-router/pull/12437)) | ||
- Generate wide `matches` and `params` types for current route and child routes ([#12397](https://github.com/remix-run/react-router/pull/12397)) | ||
At runtime, `matches` includes child route matches and `params` include child route path parameters. | ||
But previously, we only generated types for parent routes in `matches`; for `params`, we only considered the parent routes and the current route. | ||
To align our generated types more closely to the runtime behavior, we now generate more permissive, wider types when accessing child route information. | ||
## 7.0.1 | ||
## 7.0.0 | ||
### Major Changes | ||
- Remove the original `defer` implementation in favor of using raw promises via single fetch and `turbo-stream`. This removes these exports from React Router: ([#11744](https://github.com/remix-run/react-router/pull/11744)) | ||
- `defer` | ||
- `AbortedDeferredError` | ||
- `type TypedDeferredData` | ||
- `UNSAFE_DeferredData` | ||
- `UNSAFE_DEFERRED_SYMBOL`, | ||
- - Collapse `@remix-run/router` into `react-router` ([#11505](https://github.com/remix-run/react-router/pull/11505)) | ||
- Collapse `react-router-dom` into `react-router` | ||
- Collapse `@remix-run/server-runtime` into `react-router` | ||
- Collapse `@remix-run/testing` into `react-router` | ||
- Remove single_fetch future flag. ([#11522](https://github.com/remix-run/react-router/pull/11522)) | ||
- Drop support for Node 16, React Router SSR now requires Node 18 or higher ([#11391](https://github.com/remix-run/react-router/pull/11391)) | ||
- Remove `future.v7_startTransition` flag ([#11696](https://github.com/remix-run/react-router/pull/11696)) | ||
- - Expose the underlying router promises from the following APIs for compsition in React 19 APIs: ([#11521](https://github.com/remix-run/react-router/pull/11521)) | ||
- `useNavigate()` | ||
- `useSubmit` | ||
- `useFetcher().load` | ||
- `useFetcher().submit` | ||
- `useRevalidator.revalidate` | ||
- Remove `future.v7_normalizeFormMethod` future flag ([#11697](https://github.com/remix-run/react-router/pull/11697)) | ||
- For Remix consumers migrating to React Router, the `crypto` global from the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) is now required when using cookie and session APIs. This means that the following APIs are provided from `react-router` rather than platform-specific packages: ([#11837](https://github.com/remix-run/react-router/pull/11837)) | ||
- `createCookie` | ||
- `createCookieSessionStorage` | ||
- `createMemorySessionStorage` | ||
- `createSessionStorage` | ||
For consumers running older versions of Node, the `installGlobals` function from `@remix-run/node` has been updated to define `globalThis.crypto`, using [Node's `require('node:crypto').webcrypto` implementation.](https://nodejs.org/api/webcrypto.html) | ||
Since platform-specific packages no longer need to implement this API, the following low-level APIs have been removed: | ||
- `createCookieFactory` | ||
- `createSessionStorageFactory` | ||
- `createCookieSessionStorageFactory` | ||
- `createMemorySessionStorageFactory` | ||
- Imports/Exports cleanup ([#11840](https://github.com/remix-run/react-router/pull/11840)) | ||
- Removed the following exports that were previously public API from `@remix-run/router` | ||
- types | ||
- `AgnosticDataIndexRouteObject` | ||
- `AgnosticDataNonIndexRouteObject` | ||
- `AgnosticDataRouteMatch` | ||
- `AgnosticDataRouteObject` | ||
- `AgnosticIndexRouteObject` | ||
- `AgnosticNonIndexRouteObject` | ||
- `AgnosticRouteMatch` | ||
- `AgnosticRouteObject` | ||
- `TrackedPromise` | ||
- `unstable_AgnosticPatchRoutesOnMissFunction` | ||
- `Action` -> exported as `NavigationType` via `react-router` | ||
- `Router` exported as `DataRouter` to differentiate from RR's `<Router>` | ||
- API | ||
- `getToPathname` (`@private`) | ||
- `joinPaths` (`@private`) | ||
- `normalizePathname` (`@private`) | ||
- `resolveTo` (`@private`) | ||
- `stripBasename` (`@private`) | ||
- `createBrowserHistory` -> in favor of `createBrowserRouter` | ||
- `createHashHistory` -> in favor of `createHashRouter` | ||
- `createMemoryHistory` -> in favor of `createMemoryRouter` | ||
- `createRouter` | ||
- `createStaticHandler` -> in favor of wrapper `createStaticHandler` in RR Dom | ||
- `getStaticContextFromError` | ||
- Removed the following exports that were previously public API from `react-router` | ||
- `Hash` | ||
- `Pathname` | ||
- `Search` | ||
- update minimum node version to 18 ([#11690](https://github.com/remix-run/react-router/pull/11690)) | ||
- Remove `future.v7_prependBasename` from the ionternalized `@remix-run/router` package ([#11726](https://github.com/remix-run/react-router/pull/11726)) | ||
- Migrate Remix type generics to React Router ([#12180](https://github.com/remix-run/react-router/pull/12180)) | ||
- These generics are provided for Remix v2 migration purposes | ||
- These generics and the APIs they exist on should be considered informally deprecated in favor of the new `Route.*` types | ||
- Anyone migrating from React Router v6 should probably not leverage these new generics and should migrate straight to the `Route.*` types | ||
- For React Router v6 users, these generics are new and should not impact your app, with one exception | ||
- `useFetcher` previously had an optional generic (used primarily by Remix v2) that expected the data type | ||
- This has been updated in v7 to expect the type of the function that generates the data (i.e., `typeof loader`/`typeof action`) | ||
- Therefore, you should update your usages: | ||
- ❌ `useFetcher<LoaderData>()` | ||
- ✅ `useFetcher<typeof loader>()` | ||
- Remove `future.v7_throwAbortReason` from internalized `@remix-run/router` package ([#11728](https://github.com/remix-run/react-router/pull/11728)) | ||
- Add `exports` field to all packages ([#11675](https://github.com/remix-run/react-router/pull/11675)) | ||
- node package no longer re-exports from react-router ([#11702](https://github.com/remix-run/react-router/pull/11702)) | ||
- renamed RemixContext to FrameworkContext ([#11705](https://github.com/remix-run/react-router/pull/11705)) | ||
- updates the minimum React version to 18 ([#11689](https://github.com/remix-run/react-router/pull/11689)) | ||
- PrefetchPageDescriptor replaced by PageLinkDescriptor ([#11960](https://github.com/remix-run/react-router/pull/11960)) | ||
- - Consolidate types previously duplicated across `@remix-run/router`, `@remix-run/server-runtime`, and `@remix-run/react` now that they all live in `react-router` ([#12177](https://github.com/remix-run/react-router/pull/12177)) | ||
- Examples: `LoaderFunction`, `LoaderFunctionArgs`, `ActionFunction`, `ActionFunctionArgs`, `DataFunctionArgs`, `RouteManifest`, `LinksFunction`, `Route`, `EntryRoute` | ||
- The `RouteManifest` type used by the "remix" code is now slightly stricter because it is using the former `@remix-run/router` `RouteManifest` | ||
- `Record<string, Route> -> Record<string, Route | undefined>` | ||
- Removed `AppData` type in favor of inlining `unknown` in the few locations it was used | ||
- Removed `ServerRuntimeMeta*` types in favor of the `Meta*` types they were duplicated from | ||
- - Remove the `future.v7_partialHydration` flag ([#11725](https://github.com/remix-run/react-router/pull/11725)) | ||
- This also removes the `<RouterProvider fallbackElement>` prop | ||
- To migrate, move the `fallbackElement` to a `hydrateFallbackElement`/`HydrateFallback` on your root route | ||
- Also worth nothing there is a related breaking changer with this future flag: | ||
- Without `future.v7_partialHydration` (when using `fallbackElement`), `state.navigation` was populated during the initial load | ||
- With `future.v7_partialHydration`, `state.navigation` remains in an `"idle"` state during the initial load | ||
- Remove `v7_relativeSplatPath` future flag ([#11695](https://github.com/remix-run/react-router/pull/11695)) | ||
- Drop support for Node 18, update minimum Node vestion to 20 ([#12171](https://github.com/remix-run/react-router/pull/12171)) | ||
- Remove `installGlobals()` as this should no longer be necessary | ||
- Remove remaining future flags ([#11820](https://github.com/remix-run/react-router/pull/11820)) | ||
- React Router `v7_skipActionErrorRevalidation` | ||
- Remix `v3_fetcherPersist`, `v3_relativeSplatPath`, `v3_throwAbortReason` | ||
- rename createRemixStub to createRoutesStub ([#11692](https://github.com/remix-run/react-router/pull/11692)) | ||
- Remove `@remix-run/router` deprecated `detectErrorBoundary` option in favor of `mapRouteProperties` ([#11751](https://github.com/remix-run/react-router/pull/11751)) | ||
- Add `react-router/dom` subpath export to properly enable `react-dom` as an optional `peerDependency` ([#11851](https://github.com/remix-run/react-router/pull/11851)) | ||
- This ensures that we don't blindly `import ReactDOM from "react-dom"` in `<RouterProvider>` in order to access `ReactDOM.flushSync()`, since that would break `createMemoryRouter` use cases in non-DOM environments | ||
- DOM environments should import from `react-router/dom` to get the proper component that makes `ReactDOM.flushSync()` available: | ||
- If you are using the Vite plugin, use this in your `entry.client.tsx`: | ||
- `import { HydratedRouter } from 'react-router/dom'` | ||
- If you are not using the Vite plugin and are manually calling `createBrowserRouter`/`createHashRouter`: | ||
- `import { RouterProvider } from "react-router/dom"` | ||
- Remove `future.v7_fetcherPersist` flag ([#11731](https://github.com/remix-run/react-router/pull/11731)) | ||
- Update `cookie` dependency to `^1.0.1` - please see the [release notes](https://github.com/jshttp/cookie/releases) for any breaking changes ([#12172](https://github.com/remix-run/react-router/pull/12172)) | ||
### Minor Changes | ||
- - Add support for `prerender` config in the React Router vite plugin, to support existing SSG use-cases ([#11539](https://github.com/remix-run/react-router/pull/11539)) | ||
- You can use the `prerender` config to pre-render your `.html` and `.data` files at build time and then serve them statically at runtime (either from a running server or a CDN) | ||
- `prerender` can either be an array of string paths, or a function (sync or async) that returns an array of strings so that you can dynamically generate the paths by talking to your CMS, etc. | ||
```ts | ||
// react-router.config.ts | ||
import type { Config } from "@react-router/dev/config"; | ||
export default { | ||
async prerender() { | ||
let slugs = await fakeGetSlugsFromCms(); | ||
// Prerender these paths into `.html` files at build time, and `.data` | ||
// files if they have loaders | ||
return ["/", "/about", ...slugs.map((slug) => `/product/${slug}`)]; | ||
}, | ||
} satisfies Config; | ||
async function fakeGetSlugsFromCms() { | ||
await new Promise((r) => setTimeout(r, 1000)); | ||
return ["shirt", "hat"]; | ||
} | ||
``` | ||
- Params, loader data, and action data as props for route component exports ([#11961](https://github.com/remix-run/react-router/pull/11961)) | ||
```tsx | ||
export default function Component({ params, loaderData, actionData }) {} | ||
export function HydrateFallback({ params }) {} | ||
export function ErrorBoundary({ params, loaderData, actionData }) {} | ||
``` | ||
- Remove duplicate `RouterProvider` impliementations ([#11679](https://github.com/remix-run/react-router/pull/11679)) | ||
- ### Typesafety improvements ([#12019](https://github.com/remix-run/react-router/pull/12019)) | ||
React Router now generates types for each of your route modules. | ||
You can access those types by importing them from `./+types.<route filename without extension>`. | ||
For example: | ||
```ts | ||
// app/routes/product.tsx | ||
import type * as Route from "./+types.product"; | ||
export function loader({ params }: Route.LoaderArgs) {} | ||
export default function Component({ loaderData }: Route.ComponentProps) {} | ||
``` | ||
This initial implementation targets type inference for: | ||
- `Params` : Path parameters from your routing config in `routes.ts` including file-based routing | ||
- `LoaderData` : Loader data from `loader` and/or `clientLoader` within your route module | ||
- `ActionData` : Action data from `action` and/or `clientAction` within your route module | ||
In the future, we plan to add types for the rest of the route module exports: `meta`, `links`, `headers`, `shouldRevalidate`, etc. | ||
We also plan to generate types for typesafe `Link`s: | ||
```tsx | ||
<Link to="/products/:id" params={{ id: 1 }} /> | ||
// ^^^^^^^^^^^^^ ^^^^^^^^^ | ||
// typesafe `to` and `params` based on the available routes in your app | ||
``` | ||
Check out our docs for more: | ||
- [_Explanations > Type Safety_](https://reactrouter.com/dev/guides/explanation/type-safety) | ||
- [_How-To > Setting up type safety_](https://reactrouter.com/dev/guides/how-to/setting-up-type-safety) | ||
- Stabilize `unstable_dataStrategy` ([#11969](https://github.com/remix-run/react-router/pull/11969)) | ||
- Stabilize `unstable_patchRoutesOnNavigation` ([#11970](https://github.com/remix-run/react-router/pull/11970)) | ||
### Patch Changes | ||
- No changes ([`506329c4e`](https://github.com/remix-run/react-router/commit/506329c4e2e7aba9837cbfa44df6103b49423745)) | ||
- chore: re-enable development warnings through a `development` exports condition. ([#12269](https://github.com/remix-run/react-router/pull/12269)) | ||
- Remove unstable upload handler. ([#12015](https://github.com/remix-run/react-router/pull/12015)) | ||
- Remove unneeded dependency on @web3-storage/multipart-parser ([#12274](https://github.com/remix-run/react-router/pull/12274)) | ||
- Fix redirects returned from loaders/actions using `data()` ([#12021](https://github.com/remix-run/react-router/pull/12021)) | ||
- fix(react-router): (v7) fix static prerender of non-ascii characters ([#12161](https://github.com/remix-run/react-router/pull/12161)) | ||
- Replace `substr` with `substring` ([#12080](https://github.com/remix-run/react-router/pull/12080)) | ||
- Remove the deprecated `json` utility ([#12146](https://github.com/remix-run/react-router/pull/12146)) | ||
- You can use [`Response.json`](https://developer.mozilla.org/en-US/docs/Web/API/Response/json_static) if you still need to construct JSON responses in your app | ||
- Remove unneeded dependency on source-map ([#12275](https://github.com/remix-run/react-router/pull/12275)) | ||
## 6.28.0 | ||
### Minor Changes | ||
- - Log deprecation warnings for v7 flags ([#11750](https://github.com/remix-run/react-router/pull/11750)) | ||
- Add deprecation warnings to `json`/`defer` in favor of returning raw objects | ||
- These methods will be removed in React Router v7 | ||
### Patch Changes | ||
- Update JSDoc URLs for new website structure (add /v6/ segment) ([#12141](https://github.com/remix-run/react-router/pull/12141)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.21.0` | ||
## 6.27.0 | ||
### Minor Changes | ||
- Stabilize `unstable_patchRoutesOnNavigation` ([#11973](https://github.com/remix-run/react-router/pull/11973)) | ||
- Add new `PatchRoutesOnNavigationFunctionArgs` type for convenience ([#11967](https://github.com/remix-run/react-router/pull/11967)) | ||
- Stabilize `unstable_dataStrategy` ([#11974](https://github.com/remix-run/react-router/pull/11974)) | ||
- Stabilize the `unstable_flushSync` option for navigations and fetchers ([#11989](https://github.com/remix-run/react-router/pull/11989)) | ||
- Stabilize the `unstable_viewTransition` option for navigations and the corresponding `unstable_useViewTransitionState` hook ([#11989](https://github.com/remix-run/react-router/pull/11989)) | ||
### Patch Changes | ||
- Fix bug when submitting to the current contextual route (parent route with an index child) when an `?index` param already exists from a prior submission ([#12003](https://github.com/remix-run/react-router/pull/12003)) | ||
- Fix `useFormAction` bug - when removing `?index` param it would not keep other non-Remix `index` params ([#12003](https://github.com/remix-run/react-router/pull/12003)) | ||
- Fix types for `RouteObject` within `PatchRoutesOnNavigationFunction`'s `patch` method so it doesn't expect agnostic route objects passed to `patch` ([#11967](https://github.com/remix-run/react-router/pull/11967)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.20.0` | ||
## 6.26.2 | ||
### Patch Changes | ||
- Updated dependencies: | ||
- `@remix-run/router@1.19.2` | ||
## 6.26.1 | ||
### Patch Changes | ||
- Rename `unstable_patchRoutesOnMiss` to `unstable_patchRoutesOnNavigation` to match new behavior ([#11888](https://github.com/remix-run/react-router/pull/11888)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.19.1` | ||
## 6.26.0 | ||
### Minor Changes | ||
- Add a new `replace(url, init?)` alternative to `redirect(url, init?)` that performs a `history.replaceState` instead of a `history.pushState` on client-side navigation redirects ([#11811](https://github.com/remix-run/react-router/pull/11811)) | ||
### Patch Changes | ||
- Fix initial hydration behavior when using `future.v7_partialHydration` along with `unstable_patchRoutesOnMiss` ([#11838](https://github.com/remix-run/react-router/pull/11838)) | ||
- During initial hydration, `router.state.matches` will now include any partial matches so that we can render ancestor `HydrateFallback` components | ||
- Updated dependencies: | ||
- `@remix-run/router@1.19.0` | ||
## 6.25.1 | ||
No significant changes to this package were made in this release. [See the repo `CHANGELOG.md`](https://github.com/remix-run/react-router/blob/main/CHANGELOG.md) for an overview of all changes in v6.25.1. | ||
## 6.25.0 | ||
### Minor Changes | ||
- Stabilize `future.unstable_skipActionErrorRevalidation` as `future.v7_skipActionErrorRevalidation` ([#11769](https://github.com/remix-run/react-router/pull/11769)) | ||
- When this flag is enabled, actions will not automatically trigger a revalidation if they return/throw a `Response` with a `4xx`/`5xx` status code | ||
- You may still opt-into revalidation via `shouldRevalidate` | ||
- This also changes `shouldRevalidate`'s `unstable_actionStatus` parameter to `actionStatus` | ||
### Patch Changes | ||
- Fix regression and properly decode paths inside `useMatch` so matches/params reflect decoded params ([#11789](https://github.com/remix-run/react-router/pull/11789)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.18.0` | ||
## 6.24.1 | ||
### Patch Changes | ||
- When using `future.v7_relativeSplatPath`, properly resolve relative paths in splat routes that are children of pathless routes ([#11633](https://github.com/remix-run/react-router/pull/11633)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.17.1` | ||
## 6.24.0 | ||
### Minor Changes | ||
- Add support for Lazy Route Discovery (a.k.a. Fog of War) ([#11626](https://github.com/remix-run/react-router/pull/11626)) | ||
- RFC: <https://github.com/remix-run/react-router/discussions/11113> | ||
- `unstable_patchRoutesOnMiss` docs: <https://reactrouter.com/v6/routers/create-browser-router> | ||
### Patch Changes | ||
- Updated dependencies: | ||
- `@remix-run/router@1.17.0` | ||
## 6.23.1 | ||
### Patch Changes | ||
- allow undefined to be resolved with `<Await>` ([#11513](https://github.com/remix-run/react-router/pull/11513)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.16.1` | ||
## 6.23.0 | ||
### Minor Changes | ||
- Add a new `unstable_dataStrategy` configuration option ([#11098](https://github.com/remix-run/react-router/pull/11098)) | ||
- This option allows Data Router applications to take control over the approach for executing route loaders and actions | ||
- The default implementation is today's behavior, to fetch all loaders in parallel, but this option allows users to implement more advanced data flows including Remix single-fetch, middleware/context APIs, automatic loader caching, and more | ||
### Patch Changes | ||
- Updated dependencies: | ||
- `@remix-run/router@1.16.0` | ||
## 6.22.3 | ||
### Patch Changes | ||
- Updated dependencies: | ||
- `@remix-run/router@1.15.3` | ||
## 6.22.2 | ||
### Patch Changes | ||
- Updated dependencies: | ||
- `@remix-run/router@1.15.2` | ||
## 6.22.1 | ||
### Patch Changes | ||
- Fix encoding/decoding issues with pre-encoded dynamic parameter values ([#11199](https://github.com/remix-run/react-router/pull/11199)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.15.1` | ||
## 6.22.0 | ||
### Patch Changes | ||
- Updated dependencies: | ||
- `@remix-run/router@1.15.0` | ||
## 6.21.3 | ||
### Patch Changes | ||
- Remove leftover `unstable_` prefix from `Blocker`/`BlockerFunction` types ([#11187](https://github.com/remix-run/react-router/pull/11187)) | ||
## 6.21.2 | ||
### Patch Changes | ||
- Updated dependencies: | ||
- `@remix-run/router@1.14.2` | ||
## 6.21.1 | ||
### Patch Changes | ||
- Fix bug with `route.lazy` not working correctly on initial SPA load when `v7_partialHydration` is specified ([#11121](https://github.com/remix-run/react-router/pull/11121)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.14.1` | ||
## 6.21.0 | ||
### Minor Changes | ||
- Add a new `future.v7_relativeSplatPath` flag to implement a breaking bug fix to relative routing when inside a splat route. ([#11087](https://github.com/remix-run/react-router/pull/11087)) | ||
This fix was originally added in [#10983](https://github.com/remix-run/react-router/issues/10983) and was later reverted in [#11078](https://github.com/remix-run/react-router/pull/11078) because it was determined that a large number of existing applications were relying on the buggy behavior (see [#11052](https://github.com/remix-run/react-router/issues/11052)) | ||
**The Bug** | ||
The buggy behavior is that without this flag, the default behavior when resolving relative paths is to _ignore_ any splat (`*`) portion of the current route path. | ||
**The Background** | ||
This decision was originally made thinking that it would make the concept of nested different sections of your apps in `<Routes>` easier if relative routing would _replace_ the current splat: | ||
```jsx | ||
<BrowserRouter> | ||
<Routes> | ||
<Route path="/" element={<Home />} /> | ||
<Route path="dashboard/*" element={<Dashboard />} /> | ||
</Routes> | ||
</BrowserRouter> | ||
``` | ||
Any paths like `/dashboard`, `/dashboard/team`, `/dashboard/projects` will match the `Dashboard` route. The dashboard component itself can then render nested `<Routes>`: | ||
```jsx | ||
function Dashboard() { | ||
return ( | ||
<div> | ||
<h2>Dashboard</h2> | ||
<nav> | ||
<Link to="/">Dashboard Home</Link> | ||
<Link to="team">Team</Link> | ||
<Link to="projects">Projects</Link> | ||
</nav> | ||
<Routes> | ||
<Route path="/" element={<DashboardHome />} /> | ||
<Route path="team" element={<DashboardTeam />} /> | ||
<Route path="projects" element={<DashboardProjects />} /> | ||
</Routes> | ||
</div> | ||
); | ||
} | ||
``` | ||
Now, all links and route paths are relative to the router above them. This makes code splitting and compartmentalizing your app really easy. You could render the `Dashboard` as its own independent app, or embed it into your large app without making any changes to it. | ||
**The Problem** | ||
The problem is that this concept of ignoring part of a path breaks a lot of other assumptions in React Router - namely that `"."` always means the current location pathname for that route. When we ignore the splat portion, we start getting invalid paths when using `"."`: | ||
```jsx | ||
// If we are on URL /dashboard/team, and we want to link to /dashboard/team: | ||
function DashboardTeam() { | ||
// ❌ This is broken and results in <a href="/dashboard"> | ||
return <Link to=".">A broken link to the Current URL</Link>; | ||
// ✅ This is fixed but super unintuitive since we're already at /dashboard/team! | ||
return <Link to="./team">A broken link to the Current URL</Link>; | ||
} | ||
``` | ||
We've also introduced an issue that we can no longer move our `DashboardTeam` component around our route hierarchy easily - since it behaves differently if we're underneath a non-splat route, such as `/dashboard/:widget`. Now, our `"."` links will, properly point to ourself _inclusive of the dynamic param value_ so behavior will break from it's corresponding usage in a `/dashboard/*` route. | ||
Even worse, consider a nested splat route configuration: | ||
```jsx | ||
<BrowserRouter> | ||
<Routes> | ||
<Route path="dashboard"> | ||
<Route path="*" element={<Dashboard />} /> | ||
</Route> | ||
</Routes> | ||
</BrowserRouter> | ||
``` | ||
Now, a `<Link to=".">` and a `<Link to="..">` inside the `Dashboard` component go to the same place! That is definitely not correct! | ||
Another common issue arose in Data Routers (and Remix) where any `<Form>` should post to it's own route `action` if you the user doesn't specify a form action: | ||
```jsx | ||
let router = createBrowserRouter({ | ||
path: "/dashboard", | ||
children: [ | ||
{ | ||
path: "*", | ||
action: dashboardAction, | ||
Component() { | ||
// ❌ This form is broken! It throws a 405 error when it submits because | ||
// it tries to submit to /dashboard (without the splat value) and the parent | ||
// `/dashboard` route doesn't have an action | ||
return <Form method="post">...</Form>; | ||
}, | ||
}, | ||
], | ||
}); | ||
``` | ||
This is just a compounded issue from the above because the default location for a `Form` to submit to is itself (`"."`) - and if we ignore the splat portion, that now resolves to the parent route. | ||
**The Solution** | ||
If you are leveraging this behavior, it's recommended to enable the future flag, move your splat to it's own route, and leverage `../` for any links to "sibling" pages: | ||
```jsx | ||
<BrowserRouter> | ||
<Routes> | ||
<Route path="dashboard"> | ||
<Route index path="*" element={<Dashboard />} /> | ||
</Route> | ||
</Routes> | ||
</BrowserRouter> | ||
function Dashboard() { | ||
return ( | ||
<div> | ||
<h2>Dashboard</h2> | ||
<nav> | ||
<Link to="..">Dashboard Home</Link> | ||
<Link to="../team">Team</Link> | ||
<Link to="../projects">Projects</Link> | ||
</nav> | ||
<Routes> | ||
<Route path="/" element={<DashboardHome />} /> | ||
<Route path="team" element={<DashboardTeam />} /> | ||
<Route path="projects" element={<DashboardProjects />} /> | ||
</Router> | ||
</div> | ||
); | ||
} | ||
``` | ||
This way, `.` means "the full current pathname for my route" in all cases (including static, dynamic, and splat routes) and `..` always means "my parents pathname". | ||
### Patch Changes | ||
- Properly handle falsy error values in ErrorBoundary's ([#11071](https://github.com/remix-run/react-router/pull/11071)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.14.0` | ||
## 6.20.1 | ||
### Patch Changes | ||
- Revert the `useResolvedPath` fix for splat routes due to a large number of applications that were relying on the buggy behavior (see <https://github.com/remix-run/react-router/issues/11052#issuecomment-1836589329>). We plan to re-introduce this fix behind a future flag in the next minor version. ([#11078](https://github.com/remix-run/react-router/pull/11078)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.13.1` | ||
## 6.20.0 | ||
### Minor Changes | ||
- Export the `PathParam` type from the public API ([#10719](https://github.com/remix-run/react-router/pull/10719)) | ||
### Patch Changes | ||
- Fix bug with `resolveTo` in splat routes ([#11045](https://github.com/remix-run/react-router/pull/11045)) | ||
- This is a follow up to [#10983](https://github.com/remix-run/react-router/pull/10983) to handle the few other code paths using `getPathContributingMatches` | ||
- This removes the `UNSAFE_getPathContributingMatches` export from `@remix-run/router` since we no longer need this in the `react-router`/`react-router-dom` layers | ||
- Updated dependencies: | ||
- `@remix-run/router@1.13.0` | ||
## 6.19.0 | ||
### Minor Changes | ||
- Add `unstable_flushSync` option to `useNavigate`/`useSumbit`/`fetcher.load`/`fetcher.submit` to opt-out of `React.startTransition` and into `ReactDOM.flushSync` for state updates ([#11005](https://github.com/remix-run/react-router/pull/11005)) | ||
- Remove the `unstable_` prefix from the [`useBlocker`](https://reactrouter.com/v6/hooks/use-blocker) hook as it's been in use for enough time that we are confident in the API. We do not plan to remove the prefix from `unstable_usePrompt` due to differences in how browsers handle `window.confirm` that prevent React Router from guaranteeing consistent/correct behavior. ([#10991](https://github.com/remix-run/react-router/pull/10991)) | ||
### Patch Changes | ||
- Fix `useActionData` so it returns proper contextual action data and not _any_ action data in the tree ([#11023](https://github.com/remix-run/react-router/pull/11023)) | ||
- Fix bug in `useResolvedPath` that would cause `useResolvedPath(".")` in a splat route to lose the splat portion of the URL path. ([#10983](https://github.com/remix-run/react-router/pull/10983)) | ||
- ⚠️ This fixes a quite long-standing bug specifically for `"."` paths inside a splat route which incorrectly dropped the splat portion of the URL. If you are relative routing via `"."` inside a splat route in your application you should double check that your logic is not relying on this buggy behavior and update accordingly. | ||
- Updated dependencies: | ||
- `@remix-run/router@1.12.0` | ||
## 6.18.0 | ||
### Patch Changes | ||
- Fix the `future` prop on `BrowserRouter`, `HashRouter` and `MemoryRouter` so that it accepts a `Partial<FutureConfig>` instead of requiring all flags to be included. ([#10962](https://github.com/remix-run/react-router/pull/10962)) | ||
- Updated dependencies: | ||
- `@remix-run/router@1.11.0` | ||
## 6.17.0 | ||
@@ -72,3 +706,3 @@ | ||
- Move [`React.startTransition`](https://react.dev/reference/react/startTransition) usage behind a [future flag](https://reactrouter.com/en/main/guides/api-development-strategy) to avoid issues with existing incompatible `Suspense` usages. We recommend folks adopting this flag to be better compatible with React concurrent mode, but if you run into issues you can continue without the use of `startTransition` until v7. Issues usually boils down to creating net-new promises during the render cycle, so if you run into issues you should either lift your promise creation out of the render cycle or put it behind a `useMemo`. ([#10596](https://github.com/remix-run/react-router/pull/10596)) | ||
- Move [`React.startTransition`](https://react.dev/reference/react/startTransition) usage behind a [future flag](https://reactrouter.com/v6/guides/api-development-strategy) to avoid issues with existing incompatible `Suspense` usages. We recommend folks adopting this flag to be better compatible with React concurrent mode, but if you run into issues you can continue without the use of `startTransition` until v7. Issues usually boils down to creating net-new promises during the render cycle, so if you run into issues you should either lift your promise creation out of the render cycle or put it behind a `useMemo`. ([#10596](https://github.com/remix-run/react-router/pull/10596)) | ||
@@ -101,3 +735,3 @@ Existing behavior will no longer include `React.startTransition`: | ||
> **Warning** | ||
> \[!WARNING] | ||
> Please use version `6.13.0` or later instead of `6.12.1`. This version suffers from a `webpack`/`terser` minification issue resulting in invalid minified code in your resulting production bundles which can cause issues in your application. See [#10579](https://github.com/remix-run/react-router/issues/10579) for more details. | ||
@@ -157,3 +791,3 @@ | ||
- Added support for [**Future Flags**](https://reactrouter.com/en/main/guides/api-development-strategy) in React Router. The first flag being introduced is `future.v7_normalizeFormMethod` which will normalize the exposed `useNavigation()/useFetcher()` `formMethod` fields as uppercase HTTP methods to align with the `fetch()` behavior. ([#10207](https://github.com/remix-run/react-router/pull/10207)) | ||
- Added support for [**Future Flags**](https://reactrouter.com/v6/guides/api-development-strategy) in React Router. The first flag being introduced is `future.v7_normalizeFormMethod` which will normalize the exposed `useNavigation()/useFetcher()` `formMethod` fields as uppercase HTTP methods to align with the `fetch()` behavior. ([#10207](https://github.com/remix-run/react-router/pull/10207)) | ||
@@ -435,3 +1069,3 @@ - When `future.v7_normalizeFormMethod === false` (default v6 behavior), | ||
Whoa this is a big one! `6.4.0` brings all the data loading and mutation APIs over from Remix. Here's a quick high level overview, but it's recommended you go check out the [docs][rr-docs], especially the [feature overview][rr-feature-overview] and the [tutorial][rr-tutorial]. | ||
Whoa this is a big one! `6.4.0` brings all the data loading and mutation APIs over from Remix. Here's a quick high level overview, but it's recommended you go check out the [docs](https://reactrouter.com), especially the [feature overview](https://reactrouter.com/en/6.4.0/start/overview) and the [tutorial](https://reactrouter.com/en/6.4.0/start/tutorial). | ||
@@ -454,5 +1088,1 @@ **New APIs** | ||
- `@remix-run/router@1.0.0` | ||
[rr-docs]: https://reactrouter.com | ||
[rr-feature-overview]: https://reactrouter.com/start/overview | ||
[rr-tutorial]: https://reactrouter.com/start/tutorial |
{ | ||
"name": "react-router", | ||
"version": "0.0.0-experimental-65d6b8c9", | ||
"version": "0.0.0-experimental-6844c5934", | ||
"description": "Declarative routing for React", | ||
@@ -21,15 +21,84 @@ "keywords": [ | ||
"sideEffects": false, | ||
"main": "./dist/main.js", | ||
"unpkg": "./dist/umd/react-router.production.min.js", | ||
"module": "./dist/index.js", | ||
"types": "./dist/index.d.ts", | ||
"types": "./dist/development/index.d.ts", | ||
"main": "./dist/development/index.js", | ||
"module": "./dist/development/index.mjs", | ||
"exports": { | ||
".": { | ||
"node": { | ||
"types": "./dist/development/index.d.ts", | ||
"module-sync": "./dist/development/index.mjs", | ||
"default": "./dist/development/index.js" | ||
}, | ||
"import": { | ||
"types": "./dist/development/index.d.mts", | ||
"default": "./dist/development/index.mjs" | ||
}, | ||
"default": { | ||
"types": "./dist/development/index.d.ts", | ||
"default": "./dist/development/index.js" | ||
} | ||
}, | ||
"./route-module": { | ||
"import": { | ||
"types": "./dist/development/lib/types/route-module.d.mts" | ||
}, | ||
"default": { | ||
"types": "./dist/development/lib/types/route-module.d.ts" | ||
} | ||
}, | ||
"./dom": { | ||
"node": { | ||
"types": "./dist/development/dom-export.d.ts", | ||
"module-sync": "./dist/development/dom-export.mjs", | ||
"default": "./dist/development/dom-export.js" | ||
}, | ||
"import": { | ||
"types": "./dist/development/dom-export.d.mts", | ||
"default": "./dist/development/dom-export.mjs" | ||
}, | ||
"default": { | ||
"types": "./dist/development/dom-export.d.ts", | ||
"default": "./dist/development/dom-export.js" | ||
} | ||
}, | ||
"./package.json": "./package.json" | ||
}, | ||
"wireit": { | ||
"build": { | ||
"command": "rimraf dist && tsup", | ||
"files": [ | ||
"lib/**", | ||
"*.ts", | ||
"tsconfig.json", | ||
"package.json" | ||
], | ||
"output": [ | ||
"dist/**" | ||
] | ||
} | ||
}, | ||
"dependencies": { | ||
"@remix-run/router": "0.0.0-experimental-65d6b8c9" | ||
"@types/cookie": "^0.6.0", | ||
"cookie": "^1.0.1", | ||
"set-cookie-parser": "^2.6.0", | ||
"turbo-stream": "2.4.0" | ||
}, | ||
"devDependencies": { | ||
"react": "^18.2.0" | ||
"@types/set-cookie-parser": "^2.4.1", | ||
"react": "^18.2.0", | ||
"react-dom": "^18.2.0", | ||
"rimraf": "^6.0.1", | ||
"tsup": "^8.3.0", | ||
"typescript": "^5.1.6", | ||
"wireit": "0.14.9" | ||
}, | ||
"peerDependencies": { | ||
"react": ">=16.8" | ||
"react": ">=18", | ||
"react-dom": ">=18" | ||
}, | ||
"peerDependenciesMeta": { | ||
"react-dom": { | ||
"optional": true | ||
} | ||
}, | ||
"files": [ | ||
@@ -42,4 +111,7 @@ "dist/", | ||
"engines": { | ||
"node": ">=14.0.0" | ||
"node": ">=20.0.0" | ||
}, | ||
"scripts": { | ||
"build": "wireit" | ||
} | ||
} | ||
} |
@@ -1,16 +0,7 @@ | ||
# React Router | ||
`react-router` is the primary package in the React Router project. | ||
The `react-router` package is the heart of [React Router](https://github.com/remix-run/react-router) and provides all | ||
the core functionality for both | ||
[`react-router-dom`](https://github.com/remix-run/react-router/tree/main/packages/react-router-dom) | ||
and | ||
[`react-router-native`](https://github.com/remix-run/react-router/tree/main/packages/react-router-native). | ||
## Installation | ||
If you're using React Router, you should never `import` anything directly from | ||
the `react-router` package, but you should have everything you need in either | ||
`react-router-dom` or `react-router-native`. Both of those packages re-export | ||
everything from `react-router`. | ||
If you'd like to extend React Router and you know what you're doing, you should | ||
add `react-router` **as a peer dependency, not a regular dependency** in your | ||
package. | ||
```sh | ||
npm i react-router | ||
``` |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Minified code
QualityThis package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.
Found 1 instance in 1 package
2277483
42
58438
2
8
2
268
6
7
8
13
21
+ Added@types/cookie@^0.6.0
+ Addedcookie@^1.0.1
+ Addedset-cookie-parser@^2.6.0
+ Addedturbo-stream@2.4.0
+ Added@types/cookie@0.6.0(transitive)
+ Addedcookie@1.0.2(transitive)
+ Addedreact-dom@19.0.0(transitive)
+ Addedscheduler@0.25.0(transitive)
+ Addedset-cookie-parser@2.7.1(transitive)
+ Addedturbo-stream@2.4.0(transitive)
- Removed@remix-run/router@0.0.0-experimental-65d6b8c9(transitive)