34 KiB
react-router-dom
6.21.1
Patch Changes
- Updated dependencies:
react-router@6.21.1
@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)This fix was originally added in #10983 and was later reverted in #11078 because it was determined that a large number of existing applications were relying on the buggy behavior (see #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:<BrowserRouter> <Routes> <Route path="/" element={<Home />} /> <Route path="dashboard/*" element={<Dashboard />} /> </Routes> </BrowserRouter>
Any paths like
/dashboard
,/dashboard/team
,/dashboard/projects
will match theDashboard
route. The dashboard component itself can then render nested<Routes>
: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"."
:// 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:
<BrowserRouter> <Routes> <Route path="dashboard"> <Route path="*" element={<Dashboard />} /> </Route> </Routes> </BrowserRouter>
Now, a
<Link to=".">
and a<Link to="..">
inside theDashboard
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 routeaction
if you the user doesn't specify a form action: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:<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
- Updated dependencies:
@remix-run/router@1.14.0
react-router@6.21.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) - Updated dependencies:
react-router@6.20.1
@remix-run/router@1.13.1
6.20.0
Minor Changes
- Export the
PathParam
type from the public API (#10719)
Patch Changes
- Updated dependencies:
react-router@6.20.0
@remix-run/router@1.13.0
6.19.0
Minor Changes
- Add
unstable_flushSync
option touseNavigate
/useSumbit
/fetcher.load
/fetcher.submit
to opt-out ofReact.startTransition
and intoReactDOM.flushSync
for state updates (#11005) - Allow
unstable_usePrompt
to accept aBlockerFunction
in addition to aboolean
(#10991)
Patch Changes
- Fix issue where a changing fetcher
key
in auseFetcher
that remains mounted wasn't getting picked up (#11009) - Fix
useFormAction
which was incorrectly inheriting the?index
query param from child routeaction
submissions (#11025) - Fix
NavLink
active
logic whento
location has a trailing slash (#10734) - Updated dependencies:
react-router@6.19.0
@remix-run/router@1.12.0
6.18.0
Minor Changes
-
Add support for manual fetcher key specification via
useFetcher({ key: string })
so you can access the same fetcher instance from different components in your application without prop-drilling (RFC) (#10960)- Fetcher keys are now also exposed on the fetchers returned from
useFetchers
so that they can be looked up bykey
- Fetcher keys are now also exposed on the fetchers returned from
-
Add
navigate
/fetcherKey
params/props touseSumbit
/Form
to support kicking off a fetcher submission under the hood with an optionally user-specifiedkey
(#10960)- Invoking a fetcher in this way is ephemeral and stateless
- If you need to access the state of one of these fetchers, you will need to leverage
useFetcher({ key })
to look it up elsewhere
Patch Changes
- Adds a fetcher context to
RouterProvider
that holds completed fetcher data, in preparation for the upcoming future flag that will change the fetcher persistence/cleanup behavior (#10961) - Fix the
future
prop onBrowserRouter
,HashRouter
andMemoryRouter
so that it accepts aPartial<FutureConfig>
instead of requiring all flags to be included. (#10962) - Updated dependencies:
@remix-run/router@1.11.0
react-router@6.18.0
6.17.0
Minor Changes
-
Add experimental support for the View Transitions API via
document.startViewTransition
to enable CSS animated transitions on SPA navigations in your application. (#10916)The simplest approach to enabling a View Transition in your React Router app is via the new
<Link unstable_viewTransition>
prop. This will cause the navigation DOM update to be wrapped indocument.startViewTransition
which will enable transitions for the DOM update. Without any additional CSS styles, you'll get a basic cross-fade animation for your page.If you need to apply more fine-grained styles for your animations, you can leverage the
unstable_useViewTransitionState
hook which will tell you when a transition is in progress and you can use that to apply classes or styles:function ImageLink(to, src, alt) { let isTransitioning = unstable_useViewTransitionState(to); return ( <Link to={to} unstable_viewTransition> <img src={src} alt={alt} style={{ viewTransitionName: isTransitioning ? "image-expand" : "", }} /> </Link> ); }
You can also use the
<NavLink unstable_viewTransition>
shorthand which will manage the hook usage for you and automatically add atransitioning
class to the<a>
during the transition:a.transitioning img { view-transition-name: "image-expand"; }
<NavLink to={to} unstable_viewTransition> <img src={src} alt={alt} /> </NavLink>
For an example usage of View Transitions with React Router, check out our fork of the Astro Records demo.
For more information on using the View Transitions API, please refer to the Smooth and simple transitions with the View Transitions API guide from the Google Chrome team.
Please note, that because the
ViewTransition
API is a DOM API, we now export a specificRouterProvider
fromreact-router-dom
with this functionality. If you are importingRouterProvider
fromreact-router
, then it will not support view transitions. (#10928
Patch Changes
- Log a warning and fail gracefully in
ScrollRestoration
whensessionStorage
is unavailable (#10848) - Updated dependencies:
@remix-run/router@1.10.0
react-router@6.17.0
6.16.0
Minor Changes
- Updated dependencies:
@remix-run/router@1.9.0
react-router@6.16.0
Patch Changes
- Properly encode rendered URIs in server rendering to avoid hydration errors (#10769)
6.15.0
Minor Changes
- Add's a new
redirectDocument()
function which allows users to specify that a redirect from aloader
/action
should trigger a document reload (viawindow.location
) instead of attempting to navigate to the redirected location via React Router (#10705)
Patch Changes
- Fixes an edge-case affecting web extensions in Firefox that use
URLSearchParams
and theuseSearchParams
hook. (#10620) - Do not include hash in
useFormAction()
for unspecified actions since it cannot be determined on the server and causes hydration issues (#10758) - Reorder effects in
unstable_usePrompt
to avoid throwing an exception if the prompt is unblocked and a navigation is performed synchronously (#10687, #10718) - Updated dependencies:
@remix-run/router@1.8.0
react-router@6.15.0
6.14.2
Patch Changes
- Properly decode element id when emulating hash scrolling via
<ScrollRestoration>
(#10682) - Add missing
<Form state>
prop to populatehistory.state
on submission navigations (#10630) - Support proper hydration of
Error
subclasses such asReferenceError
/TypeError
(#10633) - Updated dependencies:
@remix-run/router@1.7.2
react-router@6.14.2
6.14.1
Patch Changes
- Updated dependencies:
react-router@6.14.1
@remix-run/router@1.7.1
6.14.0
Minor Changes
-
Add support for
application/json
andtext/plain
encodings foruseSubmit
/fetcher.submit
. To reflect these additional types,useNavigation
/useFetcher
now also containnavigation.json
/navigation.text
andfetcher.json
/fetcher.text
which include the json/text submission if applicable (#10413)// The default behavior will still serialize as FormData function Component() { let navigation = useNavigation(); let submit = useSubmit(); submit({ key: "value" }, { method: "post" }); // navigation.formEncType => "application/x-www-form-urlencoded" // navigation.formData => FormData instance } async function action({ request }) { // request.headers.get("Content-Type") => "application/x-www-form-urlencoded" // await request.formData() => FormData instance }
// Opt-into JSON encoding with `encType: "application/json"` function Component() { let navigation = useNavigation(); let submit = useSubmit(); submit({ key: "value" }, { method: "post", encType: "application/json" }); // navigation.formEncType => "application/json" // navigation.json => { key: "value" } } async function action({ request }) { // request.headers.get("Content-Type") => "application/json" // await request.json() => { key: "value" } }
// Opt-into text encoding with `encType: "text/plain"` function Component() { let navigation = useNavigation(); let submit = useSubmit(); submit("Text submission", { method: "post", encType: "text/plain" }); // navigation.formEncType => "text/plain" // navigation.text => "Text submission" } async function action({ request }) { // request.headers.get("Content-Type") => "text/plain" // await request.text() => "Text submission" }
Patch Changes
- When submitting a form from a
submitter
element, prefer the built-innew FormData(form, submitter)
instead of the previous manual approach in modern browsers (those that support the newsubmitter
parameter) (#9865, #10627)- For browsers that don't support it, we continue to just append the submit button's entry to the end, and we also add rudimentary support for
type="image"
buttons - If developers want full spec-compliant support for legacy browsers, they can use the
formdata-submitter-polyfill
- For browsers that don't support it, we continue to just append the submit button's entry to the end, and we also add rudimentary support for
- Call
window.history.pushState/replaceState
before updating React Router state (instead of after) so thatwindow.location
matchesuseLocation
during synchronous React 17 rendering (#10448)- ⚠️ However, generally apps should not be relying on
window.location
and should always referenceuseLocation
when possible, aswindow.location
will not be in sync 100% of the time (due topopstate
events, concurrent mode, etc.)
- ⚠️ However, generally apps should not be relying on
- Fix
tsc --skipLibCheck:false
issues on React 17 (#10622) - Upgrade
typescript
to 5.1 (#10581) - Updated dependencies:
react-router@6.14.0
@remix-run/router@1.7.0
6.13.0
Minor Changes
-
Move
React.startTransition
usage behind a future flag to avoid issues with existing incompatibleSuspense
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 ofstartTransition
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 auseMemo
. (#10596)Existing behavior will no longer include
React.startTransition
:<BrowserRouter> <Routes>{/*...*/}</Routes> </BrowserRouter> <RouterProvider router={router} />
If you wish to enable
React.startTransition
, pass the future flag to your component:<BrowserRouter future={{ v7_startTransition: true }}> <Routes>{/*...*/}</Routes> </BrowserRouter> <RouterProvider router={router} future={{ v7_startTransition: true }}/>
Patch Changes
- Work around webpack/terser
React.startTransition
minification bug in production mode (#10588) - Updated dependencies:
react-router@6.13.0
6.12.1
Warning
Please use version
6.13.0
or later instead of6.12.1
. This version suffers from awebpack
/terser
minification issue resulting in invalid minified code in your resulting production bundles which can cause issues in your application. See #10579 for more details.
Patch Changes
- Adjust feature detection of
React.startTransition
to fix webpack + react 17 compilation error (#10569) - Updated dependencies:
react-router@6.12.1
6.12.0
Minor Changes
- Wrap internal router state updates with
React.startTransition
if it exists (#10438)
Patch Changes
- Re-throw
DOMException
(DataCloneError
) when attempting to perform aPUSH
navigation with non-serializable state. (#10427) - Updated dependencies:
@remix-run/router@1.6.3
react-router@6.12.0
6.11.2
Patch Changes
- Export
SetURLSearchParams
type (#10444) - Updated dependencies:
react-router@6.11.2
@remix-run/router@1.6.2
6.11.1
Patch Changes
- Updated dependencies:
react-router@6.11.1
@remix-run/router@1.6.1
6.11.0
Minor Changes
- Enable
basename
support inuseFetcher
(#10336)- If you were previously working around this issue by manually prepending the
basename
then you will need to remove the manually prependedbasename
from yourfetcher
calls (fetcher.load('/basename/route') -> fetcher.load('/route')
)
- If you were previously working around this issue by manually prepending the
Patch Changes
- Fix inadvertent re-renders when using
Component
instead ofelement
on a route definition (#10287) - Fail gracefully on
<Link to="//">
and other invalid URL values (#10367) - Switched from
useSyncExternalStore
touseState
for internal@remix-run/router
router state syncing in<RouterProvider>
. We found some subtle bugs where router state updates got propagated before other normaluseState
updates, which could lead to footguns inuseEffect
calls. (#10377, #10409) - Add static prop to
StaticRouterProvider
's internalRouter
component (#10401) - 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 onuseLocation()
. When usingBrowserRouter
, these hooks remain unstable across location changes because they still rely onuseLocation()
. (#10336) - Updated dependencies:
react-router@6.11.0
@remix-run/router@1.6.0
6.10.0
Minor Changes
-
Added support for Future Flags in React Router. The first flag being introduced is
future.v7_normalizeFormMethod
which will normalize the exposeduseNavigation()/useFetcher()
formMethod
fields as uppercase HTTP methods to align with thefetch()
behavior. (#10207)- When
future.v7_normalizeFormMethod === false
(default v6 behavior),useNavigation().formMethod
is lowercaseuseFetcher().formMethod
is lowercase
- When
future.v7_normalizeFormMethod === true
:useNavigation().formMethod
is uppercaseuseFetcher().formMethod
is uppercase
- When
Patch Changes
- Fix
createStaticHandler
to also check forErrorBoundary
on routes in addition toerrorElement
(#10190) - Updated dependencies:
@remix-run/router@1.5.0
react-router@6.10.0
6.9.0
Minor Changes
-
React Router now supports an alternative way to define your route
element
anderrorElement
fields as React Components instead of React Elements. You can instead pass a React Component to the newComponent
andErrorBoundary
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 doComponent
/ErrorBoundary
will "win". (#10045)Example JSON Syntax
// Both of these work the same: const elementRoutes = [{ path: '/', element: <Home />, errorElement: <HomeError />, }] const componentRoutes = [{ path: '/', Component: Home, ErrorBoundary: HomeError, }] function Home() { ... } function HomeError() { ... }
Example JSX Syntax
// Both of these work the same: const elementRoutes = createRoutesFromElements( <Route path='/' element={<Home />} errorElement={<HomeError /> } /> ); const componentRoutes = createRoutesFromElements( <Route path='/' Component={Home} ErrorBoundary={HomeError} /> ); function Home() { ... } function HomeError() { ... }
-
Introducing Lazy Route Modules! (#10045)
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
).Lazy routes are resolved on initial load and during the
loading
orsubmitting
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.Your
lazy
functions will typically return the result of a dynamic import.// In this example, we assume most folks land on the homepage so we include that // in our critical-path bundle, but then we lazily load modules for /a and /b so // they don't load until the user navigates to those routes let routes = createRoutesFromElements( <Route path="/" element={<Layout />}> <Route index element={<Home />} /> <Route path="a" lazy={() => import("./a")} /> <Route path="b" lazy={() => import("./b")} /> </Route> );
Then in your lazy route modules, export the properties you want defined for the route:
export async function loader({ request }) { let data = await fetchData(request); return json(data); } // Export a `Component` directly instead of needing to create a React Element from it export function Component() { let data = useLoaderData(); return ( <> <h1>You made it!</h1> <p>{data}</p> </> ); } // Export an `ErrorBoundary` directly instead of needing to create a React Element from it export function ErrorBoundary() { let error = useRouteError(); return isRouteErrorResponse(error) ? ( <h1> {error.status} {error.statusText} </h1> ) : ( <h1>{error.message || error}</h1> ); }
An example of this in action can be found in the
examples/lazy-loading-router-provider
directory of the repository.🙌 Huge thanks to @rossipedia for the Initial Proposal and POC Implementation.
-
Updated dependencies:
react-router@6.9.0
@remix-run/router@1.4.0
6.8.2
Patch Changes
- Treat same-origin absolute URLs in
<Link to>
as external if they are outside of the routerbasename
(#10135) - Fix
useBlocker
to returnIDLE_BLOCKER
during SSR (#10046) - Fix SSR of absolute
<Link to>
urls (#10112) - Properly escape HTML characters in
StaticRouterProvider
serialized hydration data (#10068) - Updated dependencies:
@remix-run/router@1.3.3
react-router@6.8.2
6.8.1
Patch Changes
- Improved absolute url detection in
Link
component (now also supportsmailto:
urls) (#9994) - Fix partial object (search or hash only) pathnames losing current path value (#10029)
- Updated dependencies:
react-router@6.8.1
@remix-run/router@1.3.2
6.8.0
Minor Changes
-
Support absolute URLs in
<Link to>
. If the URL is for the current origin, it will still do a client-side navigation. If the URL is for a different origin then it will do a fresh document request for the new origin. (#9900)<Link to="https://neworigin.com/some/path"> {/* Document request */} <Link to="//neworigin.com/some/path"> {/* Document request */} <Link to="https://www.currentorigin.com/path"> {/* Client-side navigation */}
Patch Changes
- Fix bug with search params removal via
useSearchParams
(#9969) - Respect
preventScrollReset
on<fetcher.Form>
(#9963) - Fix navigation for hash routers on manual URL changes (#9980)
- Use
pagehide
instead ofbeforeunload
for<ScrollRestoration>
. This has better cross-browser support, specifically on Mobile Safari. (#9945) - Updated dependencies:
@remix-run/router@1.3.1
react-router@6.8.0
6.7.0
Minor Changes
- Add
unstable_useBlocker
hook for blocking navigations within the app's location origin (#9709) - Add
unstable_usePrompt
hook for blocking navigations within the app's location origin (#9932) - Add
preventScrollReset
prop to<Form>
(#9886)
Patch Changes
- Added pass-through event listener options argument to
useBeforeUnload
(#9709) - Streamline jsdom bug workaround in tests (#9824)
- Updated dependencies:
@remix-run/router@1.3.0
react-router@6.7.0
6.6.2
Patch Changes
- Ensure
useId
consistency during SSR (#9805) - Updated dependencies:
react-router@6.6.2
6.6.1
Patch Changes
- Updated dependencies:
@remix-run/router@1.2.1
react-router@6.6.1
6.6.0
Minor Changes
- Add
useBeforeUnload()
hook (#9664) - Remove
unstable_
prefix fromcreateStaticHandler
/createStaticRouter
/StaticRouterProvider
(#9738)
Patch Changes
- Proper hydration of
Error
objects fromStaticRouterProvider
(#9664) - Support uppercase
<Form method>
anduseSubmit
method values (#9664) - Skip initial scroll restoration for SSR apps with
hydrationData
(#9664) - Fix
<button formmethod>
form submission overriddes (#9664) - Updated dependencies:
@remix-run/router@1.2.0
react-router@6.6.0
6.5.0
Patch Changes
- Updated dependencies:
react-router@6.5.0
@remix-run/router@1.1.0
6.4.5
Patch Changes
- Updated dependencies:
@remix-run/router@1.0.5
react-router@6.4.5
6.4.4
Patch Changes
- Fix issues with encoded characters in
NavLink
and descendant<Routes>
(#9589, #9647) - Properly serialize/deserialize
ErrorResponse
instances when using built-in hydration (#9593) - Support
basename
in static data routers (#9591) - Updated dependencies:
@remix-run/router@1.0.4
react-router@6.4.4
6.4.3
Patch Changes
- Fix hrefs generated for
createHashRouter
(#9409) - fix encoding/matching issues with special chars (#9477, #9496)
- Properly support
index
routes with apath
inuseResolvedPath
(#9486) - Respect
relative=path
prop onNavLink
(#9453) - Fix
NavLink
behavior for root urls (#9497) - Updated dependencies:
@remix-run/router@1.0.3
react-router@6.4.3
6.4.2
Patch Changes
- Respect
basename
inuseFormAction
(#9352) - Enhance console error messages for invalid usage of data router hooks (#9311)
- 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) - Updated dependencies:
react-router@6.4.2
@remix-run/router@1.0.2
6.4.1
Patch Changes
- Updated dependencies:
react-router@6.4.1
@remix-run/router@1.0.1
6.4.0
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, especially the feature overview and the tutorial.
New APIs
- Create your router with
createMemoryRouter
/createBrowserRouter
/createHashRouter
- Render your router with
<RouterProvider>
- Load data with a Route
loader
and mutate with a Routeaction
- Handle errors with Route
errorElement
- Submit data with the new
<Form>
component - Perform in-page data loads and mutations with
useFetcher()
- Defer non-critical data with
defer
andAwait
- Manage scroll position with
<ScrollRestoration>
New Features
- Perform path-relative navigations with
<Link relative="path">
(#9160)
Bug Fixes
- Path resolution is now trailing slash agnostic (#8861)
useLocation
returns the scoped location inside a<Routes location>
component (#9094)- respect the
<Link replace>
prop if it is defined (#8779)
Updated Dependencies
react-router@6.4.0