UNPKG

22.1 kBMarkdownView Raw
1# `react-router`
2
3## 6.20.1
4
5### Patch Changes
6
7- 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))
8- Updated dependencies:
9 - `@remix-run/router@1.13.1`
10
11## 6.20.0
12
13### Minor Changes
14
15- Export the `PathParam` type from the public API ([#10719](https://github.com/remix-run/react-router/pull/10719))
16
17### Patch Changes
18
19- Fix bug with `resolveTo` in splat routes ([#11045](https://github.com/remix-run/react-router/pull/11045))
20 - 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`
21 - This removes the `UNSAFE_getPathContributingMatches` export from `@remix-run/router` since we no longer need this in the `react-router`/`react-router-dom` layers
22- Updated dependencies:
23 - `@remix-run/router@1.13.0`
24
25## 6.19.0
26
27### Minor Changes
28
29- 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))
30- Remove the `unstable_` prefix from the [`useBlocker`](https://reactrouter.com/en/main/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))
31
32### Patch Changes
33
34- 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))
35- 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))
36
37 - ⚠️ 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.
38
39- Updated dependencies:
40 - `@remix-run/router@1.12.0`
41
42## 6.18.0
43
44### Patch Changes
45
46- 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))
47- Updated dependencies:
48 - `@remix-run/router@1.11.0`
49
50## 6.17.0
51
52### Patch Changes
53
54- Fix `RouterProvider` `future` prop type to be a `Partial<FutureConfig>` so that not all flags must be specified ([#10900](https://github.com/remix-run/react-router/pull/10900))
55- Updated dependencies:
56 - `@remix-run/router@1.10.0`
57
58## 6.16.0
59
60### Minor Changes
61
62- In order to move towards stricter TypeScript support in the future, we're aiming to replace current usages of `any` with `unknown` on exposed typings for user-provided data. To do this in Remix v2 without introducing breaking changes in React Router v6, we have added generics to a number of shared types. These continue to default to `any` in React Router and are overridden with `unknown` in Remix. In React Router v7 we plan to move these to `unknown` as a breaking change. ([#10843](https://github.com/remix-run/react-router/pull/10843))
63 - `Location` now accepts a generic for the `location.state` value
64 - `ActionFunctionArgs`/`ActionFunction`/`LoaderFunctionArgs`/`LoaderFunction` now accept a generic for the `context` parameter (only used in SSR usages via `createStaticHandler`)
65 - The return type of `useMatches` (now exported as `UIMatch`) accepts generics for `match.data` and `match.handle` - both of which were already set to `unknown`
66- Move the `@private` class export `ErrorResponse` to an `UNSAFE_ErrorResponseImpl` export since it is an implementation detail and there should be no construction of `ErrorResponse` instances in userland. This frees us up to export a `type ErrorResponse` which correlates to an instance of the class via `InstanceType`. Userland code should only ever be using `ErrorResponse` as a type and should be type-narrowing via `isRouteErrorResponse`. ([#10811](https://github.com/remix-run/react-router/pull/10811))
67- Export `ShouldRevalidateFunctionArgs` interface ([#10797](https://github.com/remix-run/react-router/pull/10797))
68- Removed private/internal APIs only required for the Remix v1 backwards compatibility layer and no longer needed in Remix v2 (`_isFetchActionRedirect`, `_hasFetcherDoneAnything`) ([#10715](https://github.com/remix-run/react-router/pull/10715))
69
70### Patch Changes
71
72- Updated dependencies:
73 - `@remix-run/router@1.9.0`
74
75## 6.15.0
76
77### Minor Changes
78
79- Add's a new `redirectDocument()` function which allows users to specify that a redirect from a `loader`/`action` should trigger a document reload (via `window.location`) instead of attempting to navigate to the redirected location via React Router ([#10705](https://github.com/remix-run/react-router/pull/10705))
80
81### Patch Changes
82
83- Ensure `useRevalidator` is referentially stable across re-renders if revalidations are not actively occurring ([#10707](https://github.com/remix-run/react-router/pull/10707))
84- Updated dependencies:
85 - `@remix-run/router@1.8.0`
86
87## 6.14.2
88
89### Patch Changes
90
91- Updated dependencies:
92 - `@remix-run/router@1.7.2`
93
94## 6.14.1
95
96### Patch Changes
97
98- Fix loop in `unstable_useBlocker` when used with an unstable blocker function ([#10652](https://github.com/remix-run/react-router/pull/10652))
99- Fix issues with reused blockers on subsequent navigations ([#10656](https://github.com/remix-run/react-router/pull/10656))
100- Updated dependencies:
101 - `@remix-run/router@1.7.1`
102
103## 6.14.0
104
105### Patch Changes
106
107- Strip `basename` from locations provided to `unstable_useBlocker` functions to match `useLocation` ([#10573](https://github.com/remix-run/react-router/pull/10573))
108- Fix `generatePath` when passed a numeric `0` value parameter ([#10612](https://github.com/remix-run/react-router/pull/10612))
109- Fix `unstable_useBlocker` key issues in `StrictMode` ([#10573](https://github.com/remix-run/react-router/pull/10573))
110- Fix `tsc --skipLibCheck:false` issues on React 17 ([#10622](https://github.com/remix-run/react-router/pull/10622))
111- Upgrade `typescript` to 5.1 ([#10581](https://github.com/remix-run/react-router/pull/10581))
112- Updated dependencies:
113 - `@remix-run/router@1.7.0`
114
115## 6.13.0
116
117### Minor Changes
118
119- 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))
120
121 Existing behavior will no longer include `React.startTransition`:
122
123 ```jsx
124 <BrowserRouter>
125 <Routes>{/*...*/}</Routes>
126 </BrowserRouter>
127
128 <RouterProvider router={router} />
129 ```
130
131 If you wish to enable `React.startTransition`, pass the future flag to your component:
132
133 ```jsx
134 <BrowserRouter future={{ v7_startTransition: true }}>
135 <Routes>{/*...*/}</Routes>
136 </BrowserRouter>
137
138 <RouterProvider router={router} future={{ v7_startTransition: true }}/>
139 ```
140
141### Patch Changes
142
143- Work around webpack/terser `React.startTransition` minification bug in production mode ([#10588](https://github.com/remix-run/react-router/pull/10588))
144
145## 6.12.1
146
147> [!WARNING]
148> 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.
149
150### Patch Changes
151
152- Adjust feature detection of `React.startTransition` to fix webpack + react 17 compilation error ([#10569](https://github.com/remix-run/react-router/pull/10569))
153
154## 6.12.0
155
156### Minor Changes
157
158- Wrap internal router state updates with `React.startTransition` if it exists ([#10438](https://github.com/remix-run/react-router/pull/10438))
159
160### Patch Changes
161
162- Updated dependencies:
163 - `@remix-run/router@1.6.3`
164
165## 6.11.2
166
167### Patch Changes
168
169- Fix `basename` duplication in descendant `<Routes>` inside a `<RouterProvider>` ([#10492](https://github.com/remix-run/react-router/pull/10492))
170- Updated dependencies:
171 - `@remix-run/router@1.6.2`
172
173## 6.11.1
174
175### Patch Changes
176
177- Fix usage of `Component` API within descendant `<Routes>` ([#10434](https://github.com/remix-run/react-router/pull/10434))
178- Fix bug when calling `useNavigate` from `<Routes>` inside a `<RouterProvider>` ([#10432](https://github.com/remix-run/react-router/pull/10432))
179- Fix usage of `<Navigate>` in strict mode when using a data router ([#10435](https://github.com/remix-run/react-router/pull/10435))
180- Updated dependencies:
181 - `@remix-run/router@1.6.1`
182
183## 6.11.0
184
185### Patch Changes
186
187- Log loader/action errors to the console in dev for easier stack trace evaluation ([#10286](https://github.com/remix-run/react-router/pull/10286))
188- Fix bug preventing rendering of descendant `<Routes>` when `RouterProvider` errors existed ([#10374](https://github.com/remix-run/react-router/pull/10374))
189- Fix inadvertent re-renders when using `Component` instead of `element` on a route definition ([#10287](https://github.com/remix-run/react-router/pull/10287))
190- Fix detection of `useNavigate` in the render cycle by setting the `activeRef` in a layout effect, allowing the `navigate` function to be passed to child components and called in a `useEffect` there. ([#10394](https://github.com/remix-run/react-router/pull/10394))
191- Switched from `useSyncExternalStore` to `useState` for internal `@remix-run/router` router state syncing in `<RouterProvider>`. We found some [subtle bugs](https://codesandbox.io/s/use-sync-external-store-loop-9g7b81) where router state updates got propagated _before_ other normal `useState` updates, which could lead to footguns in `useEffect` calls. ([#10377](https://github.com/remix-run/react-router/pull/10377), [#10409](https://github.com/remix-run/react-router/pull/10409))
192- Allow `useRevalidator()` to resolve a loader-driven error boundary scenario ([#10369](https://github.com/remix-run/react-router/pull/10369))
193- Avoid unnecessary unsubscribe/resubscribes on router state changes ([#10409](https://github.com/remix-run/react-router/pull/10409))
194- When using a `RouterProvider`, `useNavigate`/`useSubmit`/`fetcher.submit` are now stable across location changes, since we can handle relative routing via the `@remix-run/router` instance and get rid of our dependence on `useLocation()`. When using `BrowserRouter`, these hooks remain unstable across location changes because they still rely on `useLocation()`. ([#10336](https://github.com/remix-run/react-router/pull/10336))
195- Updated dependencies:
196 - `@remix-run/router@1.6.0`
197
198## 6.10.0
199
200### Minor Changes
201
202- 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))
203
204 - When `future.v7_normalizeFormMethod === false` (default v6 behavior),
205 - `useNavigation().formMethod` is lowercase
206 - `useFetcher().formMethod` is lowercase
207 - When `future.v7_normalizeFormMethod === true`:
208 - `useNavigation().formMethod` is uppercase
209 - `useFetcher().formMethod` is uppercase
210
211### Patch Changes
212
213- Fix route ID generation when using Fragments in `createRoutesFromElements` ([#10193](https://github.com/remix-run/react-router/pull/10193))
214- Updated dependencies:
215 - `@remix-run/router@1.5.0`
216
217## 6.9.0
218
219### Minor Changes
220
221- React Router now supports an alternative way to define your route `element` and `errorElement` fields as React Components instead of React Elements. You can instead pass a React Component to the new `Component` and `ErrorBoundary` fields if you choose. There is no functional difference between the two, so use whichever approach you prefer 😀. You shouldn't be defining both, but if you do `Component`/`ErrorBoundary` will "win". ([#10045](https://github.com/remix-run/react-router/pull/10045))
222
223 **Example JSON Syntax**
224
225 ```jsx
226 // Both of these work the same:
227 const elementRoutes = [{
228 path: '/',
229 element: <Home />,
230 errorElement: <HomeError />,
231 }]
232
233 const componentRoutes = [{
234 path: '/',
235 Component: Home,
236 ErrorBoundary: HomeError,
237 }]
238
239 function Home() { ... }
240 function HomeError() { ... }
241 ```
242
243 **Example JSX Syntax**
244
245 ```jsx
246 // Both of these work the same:
247 const elementRoutes = createRoutesFromElements(
248 <Route path='/' element={<Home />} errorElement={<HomeError /> } />
249 );
250
251 const componentRoutes = createRoutesFromElements(
252 <Route path='/' Component={Home} ErrorBoundary={HomeError} />
253 );
254
255 function Home() { ... }
256 function HomeError() { ... }
257 ```
258
259- **Introducing Lazy Route Modules!** ([#10045](https://github.com/remix-run/react-router/pull/10045))
260
261 In order to keep your application bundles small and support code-splitting of your routes, we've introduced a new `lazy()` route property. This is an async function that resolves the non-route-matching portions of your route definition (`loader`, `action`, `element`/`Component`, `errorElement`/`ErrorBoundary`, `shouldRevalidate`, `handle`).
262
263 Lazy routes are resolved on initial load and during the `loading` or `submitting` phase of a navigation or fetcher call. You cannot lazily define route-matching properties (`path`, `index`, `children`) since we only execute your lazy route functions after we've matched known routes.
264
265 Your `lazy` functions will typically return the result of a dynamic import.
266
267 ```jsx
268 // In this example, we assume most folks land on the homepage so we include that
269 // in our critical-path bundle, but then we lazily load modules for /a and /b so
270 // they don't load until the user navigates to those routes
271 let routes = createRoutesFromElements(
272 <Route path="/" element={<Layout />}>
273 <Route index element={<Home />} />
274 <Route path="a" lazy={() => import("./a")} />
275 <Route path="b" lazy={() => import("./b")} />
276 </Route>
277 );
278 ```
279
280 Then in your lazy route modules, export the properties you want defined for the route:
281
282 ```jsx
283 export async function loader({ request }) {
284 let data = await fetchData(request);
285 return json(data);
286 }
287
288 // Export a `Component` directly instead of needing to create a React Element from it
289 export function Component() {
290 let data = useLoaderData();
291
292 return (
293 <>
294 <h1>You made it!</h1>
295 <p>{data}</p>
296 </>
297 );
298 }
299
300 // Export an `ErrorBoundary` directly instead of needing to create a React Element from it
301 export function ErrorBoundary() {
302 let error = useRouteError();
303 return isRouteErrorResponse(error) ? (
304 <h1>
305 {error.status} {error.statusText}
306 </h1>
307 ) : (
308 <h1>{error.message || error}</h1>
309 );
310 }
311 ```
312
313 An example of this in action can be found in the [`examples/lazy-loading-router-provider`](https://github.com/remix-run/react-router/tree/main/examples/lazy-loading-router-provider) directory of the repository.
314
315 🙌 Huge thanks to @rossipedia for the [Initial Proposal](https://github.com/remix-run/react-router/discussions/9826) and [POC Implementation](https://github.com/remix-run/react-router/pull/9830).
316
317- Updated dependencies:
318 - `@remix-run/router@1.4.0`
319
320### Patch Changes
321
322- Fix `generatePath` incorrectly applying parameters in some cases ([#10078](https://github.com/remix-run/react-router/pull/10078))
323- Improve memoization for context providers to avoid unnecessary re-renders ([#9983](https://github.com/remix-run/react-router/pull/9983))
324
325## 6.8.2
326
327### Patch Changes
328
329- Updated dependencies:
330 - `@remix-run/router@1.3.3`
331
332## 6.8.1
333
334### Patch Changes
335
336- Remove inaccurate console warning for POP navigations and update active blocker logic ([#10030](https://github.com/remix-run/react-router/pull/10030))
337- Updated dependencies:
338 - `@remix-run/router@1.3.2`
339
340## 6.8.0
341
342### Patch Changes
343
344- Updated dependencies:
345 - `@remix-run/router@1.3.1`
346
347## 6.7.0
348
349### Minor Changes
350
351- Add `unstable_useBlocker` hook for blocking navigations within the app's location origin ([#9709](https://github.com/remix-run/react-router/pull/9709))
352
353### Patch Changes
354
355- Fix `generatePath` when optional params are present ([#9764](https://github.com/remix-run/react-router/pull/9764))
356- Update `<Await>` to accept `ReactNode` as children function return result ([#9896](https://github.com/remix-run/react-router/pull/9896))
357- Updated dependencies:
358 - `@remix-run/router@1.3.0`
359
360## 6.6.2
361
362### Patch Changes
363
364- Ensure `useId` consistency during SSR ([#9805](https://github.com/remix-run/react-router/pull/9805))
365
366## 6.6.1
367
368### Patch Changes
369
370- Updated dependencies:
371 - `@remix-run/router@1.2.1`
372
373## 6.6.0
374
375### Patch Changes
376
377- Prevent `useLoaderData` usage in `errorElement` ([#9735](https://github.com/remix-run/react-router/pull/9735))
378- Updated dependencies:
379 - `@remix-run/router@1.2.0`
380
381## 6.5.0
382
383This release introduces support for [Optional Route Segments](https://github.com/remix-run/react-router/issues/9546). Now, adding a `?` to the end of any path segment will make that entire segment optional. This works for both static segments and dynamic parameters.
384
385**Optional Params Examples**
386
387- `<Route path=":lang?/about>` will match:
388 - `/:lang/about`
389 - `/about`
390- `<Route path="/multistep/:widget1?/widget2?/widget3?">` will match:
391 - `/multistep`
392 - `/multistep/:widget1`
393 - `/multistep/:widget1/:widget2`
394 - `/multistep/:widget1/:widget2/:widget3`
395
396**Optional Static Segment Example**
397
398- `<Route path="/home?">` will match:
399 - `/`
400 - `/home`
401- `<Route path="/fr?/about">` will match:
402 - `/about`
403 - `/fr/about`
404
405### Minor Changes
406
407- Allows optional routes and optional static segments ([#9650](https://github.com/remix-run/react-router/pull/9650))
408
409### Patch Changes
410
411- Stop incorrectly matching on partial named parameters, i.e. `<Route path="prefix-:param">`, to align with how splat parameters work. If you were previously relying on this behavior then it's recommended to extract the static portion of the path at the `useParams` call site: ([#9506](https://github.com/remix-run/react-router/pull/9506))
412
413```jsx
414// Old behavior at URL /prefix-123
415<Route path="prefix-:id" element={<Comp /> }>
416
417function Comp() {
418 let params = useParams(); // { id: '123' }
419 let id = params.id; // "123"
420 ...
421}
422
423// New behavior at URL /prefix-123
424<Route path=":id" element={<Comp /> }>
425
426function Comp() {
427 let params = useParams(); // { id: 'prefix-123' }
428 let id = params.id.replace(/^prefix-/, ''); // "123"
429 ...
430}
431```
432
433- Updated dependencies:
434 - `@remix-run/router@1.1.0`
435
436## 6.4.5
437
438### Patch Changes
439
440- Updated dependencies:
441 - `@remix-run/router@1.0.5`
442
443## 6.4.4
444
445### Patch Changes
446
447- Updated dependencies:
448 - `@remix-run/router@1.0.4`
449
450## 6.4.3
451
452### Patch Changes
453
454- `useRoutes` should be able to return `null` when passing `locationArg` ([#9485](https://github.com/remix-run/react-router/pull/9485))
455- fix `initialEntries` type in `createMemoryRouter` ([#9498](https://github.com/remix-run/react-router/pull/9498))
456- Updated dependencies:
457 - `@remix-run/router@1.0.3`
458
459## 6.4.2
460
461### Patch Changes
462
463- Fix `IndexRouteObject` and `NonIndexRouteObject` types to make `hasErrorElement` optional ([#9394](https://github.com/remix-run/react-router/pull/9394))
464- Enhance console error messages for invalid usage of data router hooks ([#9311](https://github.com/remix-run/react-router/pull/9311))
465- If an index route has children, it will result in a runtime error. We have strengthened our `RouteObject`/`RouteProps` types to surface the error in TypeScript. ([#9366](https://github.com/remix-run/react-router/pull/9366))
466- Updated dependencies:
467 - `@remix-run/router@1.0.2`
468
469## 6.4.1
470
471### Patch Changes
472
473- Preserve state from `initialEntries` ([#9288](https://github.com/remix-run/react-router/pull/9288))
474- Updated dependencies:
475 - `@remix-run/router@1.0.1`
476
477## 6.4.0
478
479Whoa 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].
480
481**New APIs**
482
483- Create your router with `createMemoryRouter`
484- Render your router with `<RouterProvider>`
485- Load data with a Route `loader` and mutate with a Route `action`
486- Handle errors with Route `errorElement`
487- Defer non-critical data with `defer` and `Await`
488
489**Bug Fixes**
490
491- Path resolution is now trailing slash agnostic (#8861)
492- `useLocation` returns the scoped location inside a `<Routes location>` component (#9094)
493
494**Updated Dependencies**
495
496- `@remix-run/router@1.0.0`
497
498[rr-docs]: https://reactrouter.com
499[rr-feature-overview]: https://reactrouter.com/start/overview
500[rr-tutorial]: https://reactrouter.com/start/tutorial