chore: Update version for release (pre) #12016
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to release-next, this PR will be updated.
release-next
is currently in pre mode so this branch has prereleases rather than normal releases. If you want to exit prereleases, runchangeset pre exit
onrelease-next
.Releases
react-router@7.0.0-pre.0
Major Changes
Remove the original
defer
implementation in favor of using raw promises via single fetch andturbo-stream
. This removes these exports from React Router: (#11744)defer
AbortedDeferredError
type TypedDeferredData
UNSAFE_DeferredData
UNSAFE_DEFERRED_SYMBOL
,@remix-run/router
intoreact-router
(#11505)react-router-dom
intoreact-router
@remix-run/server-runtime
intoreact-router
@remix-run/testing
intoreact-router
Remove single_fetch future flag. (#11522)
Drop support for Node 16, React Router SSR now requires Node 18 or higher (#11391)
Remove
future.v7_startTransition
flag (#11696)useNavigate()
useSubmit
useFetcher().load
useFetcher().submit
useRevalidator.revalidate
Remove
future.v7_normalizeFormMethod
future flag (#11697)For Remix consumers migrating to React Router, the
crypto
global from the Web Crypto API is now required when using cookie and session APIs. This means that the following APIs are provided fromreact-router
rather than platform-specific packages: (#11837)createCookie
createCookieSessionStorage
createMemorySessionStorage
createSessionStorage
For consumers running older versions of Node, the
installGlobals
function from@remix-run/node
has been updated to defineglobalThis.crypto
, using Node'srequire('node:crypto').webcrypto
implementation.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)
@remix-run/router
AgnosticDataIndexRouteObject
AgnosticDataNonIndexRouteObject
AgnosticDataRouteMatch
AgnosticDataRouteObject
AgnosticIndexRouteObject
AgnosticNonIndexRouteObject
AgnosticRouteMatch
AgnosticRouteObject
TrackedPromise
unstable_AgnosticPatchRoutesOnMissFunction
Action
-> exported asNavigationType
viareact-router
Router
exported asDataRouter
to differentiate from RR's<Router>
getToPathname
(@private
)joinPaths
(@private
)normalizePathname
(@private
)resolveTo
(@private
)stripBasename
(@private
)createBrowserHistory
-> in favor ofcreateBrowserRouter
createHashHistory
-> in favor ofcreateHashRouter
createMemoryHistory
-> in favor ofcreateMemoryRouter
createRouter
createStaticHandler
-> in favor of wrappercreateStaticHandler
in RR DomgetStaticContextFromError
react-router
Hash
Pathname
Search
update minimum node version to 18 (#11690)
Remove
future.v7_prependBasename
from the ionternalized@remix-run/router
package (#11726)Remove
future.v7_throwAbortReason
from internalized@remix-run/router
package (#11728)Add
exports
field to all packages (#11675)node package no longer re-exports from react-router (#11702)
renamed RemixContext to FrameworkContext (#11705)
updates the minimum React version to 18 (#11689)
PrefetchPageDescriptor replaced by PageLinkDescriptor (#11960)
future.v7_partialHydration
flag (#11725)<RouterProvider fallbackElement>
propfallbackElement
to ahydrateFallbackElement
/HydrateFallback
on your root routefuture.v7_partialHydration
(when usingfallbackElement
),state.navigation
was populated during the initial loadfuture.v7_partialHydration
,state.navigation
remains in an"idle"
state during the initial loadRemove
v7_relativeSplatPath
future flag (#11695)Remove remaining future flags (#11820)
v7_skipActionErrorRevalidation
v3_fetcherPersist
,v3_relativeSplatPath
,v3_throwAbortReason
rename createRemixStub to createRoutesStub (#11692)
Remove
@remix-run/router
deprecateddetectErrorBoundary
option in favor ofmapRouteProperties
(#11751)Add
react-router/dom
subpath export to properly enablereact-dom
as an optionalpeerDependency
(#11851)import ReactDOM from "react-dom"
in<RouterProvider>
in order to accessReactDOM.flushSync()
, since that would breakcreateMemoryRouter
use cases in non-DOM environmentsreact-router/dom
to get the proper component that makesReactDOM.flushSync()
available:entry.client.tsx
:import { HydratedRouter } from 'react-router/dom'
createBrowserRouter
/createHashRouter
:import { RouterProvider } from "react-router/dom"
Remove
future.v7_fetcherPersist
flag (#11731)Minor Changes
prerender
config in the React Router vite plugin, to support existing SSG use-cases (#11539)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.[REMOVE] Allow returning undefined from loaders/actions part 2 (#12057)
Params, loader data, and action data as props for route component exports (#11961)
Remove duplicate
RouterProvider
impliementations (#11679)Typesafety improvements (#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:
This initial implementation targets type inference for:
Params
: Path parameters from your routing config inroutes.ts
including file-based routingLoaderData
: Loader data fromloader
and/orclientLoader
within your route moduleActionData
: Action data fromaction
and/orclientAction
within your route moduleThese types are then used to create types for route export args and props:
LoaderArgs
ClientLoaderArgs
ActionArgs
ClientActionArgs
HydrateFallbackProps
ComponentProps
(for thedefault
export)ErrorBoundaryProps
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:Setup
React Router will generate types into a
.react-router/
directory at the root of your app.This directory is fully managed by React Router and is derived based on your route config (
routes.ts
).👉 Add
.react-router/
to.gitignore
You should also ensure that generated types for routes are always present before running typechecking,
especially for running typechecking in CI.
👉 Add
react-router typegen
to yourtypecheck
command inpackage.json
To get TypeScript to use those generated types, you'll need to add them to
include
intsconfig.json
.And to be able to import them as if they files next to your route modules, you'll also need to configure
rootDirs
.👉 Configure
tsconfig.json
for generated typestypegen
commandYou can manually generate types with the new
typegen
command:However, manual type generation is tedious and types can get out of sync quickly if you ever forget to run
typegen
.Instead, we recommend that you setup our new TypeScript plugin which will automatically generate fresh types whenever routes change.
That way, you'll always have up-to-date types.
TypeScript plugin
To get automatic type generation, you can use our new TypeScript plugin.
👉 Add the TypeScript plugin to
tsconfig.json
We plan to add some other goodies to our TypeScript plugin soon, including:
jsdoc
for route exports that include links to official docsVSCode
TypeScript looks for plugins registered in
tsconfig.json
in the localnode_modules/
,but VSCode ships with its own copy of TypeScript that is installed outside of your project.
For TypeScript plugins to work, you'll need to tell VSCode to use the local workspace version of TypeScript.
For security reasons, VSCode won't use the workspace version of TypeScript until you manually opt-in.
Your project should have a
.vscode/settings.json
with the following settings:That way VSCode will ask you if you want to use the workspace version of TypeScript the first time you open a TS file in that project.
👉 Select "Allow" when VSCode asks if you want to use the workspace version of TypeScript
Otherwise, you can also manually opt-in to the workspace version:
Select TypeScript Version
Use Workspace Version
Troubleshooting
In VSCode, open up any TypeScript file in your project and then use CMD+SHIFT+P to select
Open TS Server log
.There should be a log for
[react-router] setup
that indicates that the plugin was resolved correctly.Then look for any errors in the log.
Stabilize
unstable_dataStrategy
(#11969)Stabilize
unstable_patchRoutesOnNavigation
(#11970)Patch Changes
data()
(#12021)react-router@7.0.0-pre.0
@react-router/architect@7.0.0-pre.0
Major Changes
For Remix consumers migrating to React Router, the
crypto
global from the Web Crypto API is now required when using cookie and session APIs. This means that the following APIs are provided fromreact-router
rather than platform-specific packages: (#11837)createCookie
createCookieSessionStorage
createMemorySessionStorage
createSessionStorage
For consumers running older versions of Node, the
installGlobals
function from@remix-run/node
has been updated to defineglobalThis.crypto
, using Node'srequire('node:crypto').webcrypto
implementation.Since platform-specific packages no longer need to implement this API, the following low-level APIs have been removed:
createCookieFactory
createSessionStorageFactory
createCookieSessionStorageFactory
createMemorySessionStorageFactory
Patch Changes
react-router@7.0.0-pre.0
@react-router/node@7.0.0-pre.0
@react-router/cloudflare@7.0.0-pre.0
Major Changes
For Remix consumers migrating to React Router, all exports from
@remix-run/cloudflare-pages
are now provided for React Router consumers in the@react-router/cloudflare
package. There is no longer a separate package for Cloudflare Pages. (#11801)For Remix consumers migrating to React Router, the
crypto
global from the Web Crypto API is now required when using cookie and session APIs. This means that the following APIs are provided fromreact-router
rather than platform-specific packages: (#11837)createCookie
createCookieSessionStorage
createMemorySessionStorage
createSessionStorage
For consumers running older versions of Node, the
installGlobals
function from@remix-run/node
has been updated to defineglobalThis.crypto
, using Node'srequire('node:crypto').webcrypto
implementation.Since platform-specific packages no longer need to implement this API, the following low-level APIs have been removed:
createCookieFactory
createSessionStorageFactory
createCookieSessionStorageFactory
createMemorySessionStorageFactory
Minor Changes
@remix-run/cloudflare-workers
package has been deprecated. Remix consumers migrating to React Router should use the@react-router/cloudflare
package directly. For guidance on how to use@react-router/cloudflare
within a Cloudflare Workers context, refer to the Cloudflare Workers template. (#11801)Patch Changes
react-router@7.0.0-pre.0
@react-router/dev@7.0.0-pre.0
Major Changes
For Remix consumers migrating to React Router, the
vitePlugin
andcloudflareDevProxyVitePlugin
exports have been renamed and moved. (#11904)Remove single_fetch future flag. (#11522)
update minimum node version to 18 (#11690)
Add
exports
field to all packages (#11675)node package no longer re-exports from react-router (#11702)
For Remix consumers migrating to React Router who used the Vite plugin's
buildEnd
hook, the resolvedreactRouterConfig
object no longer contains apublicPath
property since this belongs to Vite, not React Router. (#11575)For Remix consumers migrating to React Router, the Vite plugin's
manifest
option has been removed. (#11573)The
manifest
option been superseded by the more powerfulbuildEnd
hook since it's passed thebuildManifest
argument. You can still write the build manifest to disk if needed, but you'll most likely find it more convenient to write any logic depending on the build manifest within thebuildEnd
hook itself.If you were using the
manifest
option, you can replace it with abuildEnd
hook that writes the manifest to disk like this:Update default
isbot
version to v5 and drop support forisbot@3
(#11770)isbot@4
orisbot@5
in yourpackage.json
:isbot@3
in yourpackage.json
and you have your ownentry.server.tsx
file in your repoisbot@5
independent of the React Router v7 upgradeisbot@3
in yourpackage.json
and you do not have your ownentry.server.tsx
file in your repoisbot@5
in yourpackage.json
For Remix consumers migrating to React Router, Vite manifests (i.e.
.vite/manifest.json
) are now written within each build subdirectory, e.g.build/client/.vite/manifest.json
andbuild/server/.vite/manifest.json
instead ofbuild/.vite/client-manifest.json
andbuild/.vite/server-manifest.json
. This means that the build output is now much closer to what you'd expect from a typical Vite project. (#11573)Originally the Remix Vite plugin moved all Vite manifests to a root-level
build/.vite
directory to avoid accidentally serving them in production, particularly from the client build. This was later improved with additional logic that deleted these Vite manifest files at the end of the build process unless Vite'sbuild.manifest
had been enabled within the app's Vite config. This greatly reduced the risk of accidentally serving the Vite manifests in production since they're only present when explicitly asked for. As a result, we can now assume that consumers will know that they need to manage these additional files themselves, and React Router can safely generate a more standard Vite build output.Minor Changes
Params, loader data, and action data as props for route component exports (#11961)
Remove internal entry.server.spa.tsx implementation (#11681)
Typesafety improvements (#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:
This initial implementation targets type inference for:
Params
: Path parameters from your routing config inroutes.ts
including file-based routingLoaderData
: Loader data fromloader
and/orclientLoader
within your route moduleActionData
: Action data fromaction
and/orclientAction
within your route moduleThese types are then used to create types for route export args and props:
LoaderArgs
ClientLoaderArgs
ActionArgs
ClientActionArgs
HydrateFallbackProps
ComponentProps
(for thedefault
export)ErrorBoundaryProps
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:Setup
React Router will generate types into a
.react-router/
directory at the root of your app.This directory is fully managed by React Router and is derived based on your route config (
routes.ts
).👉 Add
.react-router/
to.gitignore
You should also ensure that generated types for routes are always present before running typechecking,
especially for running typechecking in CI.
👉 Add
react-router typegen
to yourtypecheck
command inpackage.json
To get TypeScript to use those generated types, you'll need to add them to
include
intsconfig.json
.And to be able to import them as if they files next to your route modules, you'll also need to configure
rootDirs
.👉 Configure
tsconfig.json
for generated typestypegen
commandYou can manually generate types with the new
typegen
command:However, manual type generation is tedious and types can get out of sync quickly if you ever forget to run
typegen
.Instead, we recommend that you setup our new TypeScript plugin which will automatically generate fresh types whenever routes change.
That way, you'll always have up-to-date types.
TypeScript plugin
To get automatic type generation, you can use our new TypeScript plugin.
👉 Add the TypeScript plugin to
tsconfig.json
We plan to add some other goodies to our TypeScript plugin soon, including:
jsdoc
for route exports that include links to official docsVSCode
TypeScript looks for plugins registered in
tsconfig.json
in the localnode_modules/
,but VSCode ships with its own copy of TypeScript that is installed outside of your project.
For TypeScript plugins to work, you'll need to tell VSCode to use the local workspace version of TypeScript.
For security reasons, VSCode won't use the workspace version of TypeScript until you manually opt-in.
Your project should have a
.vscode/settings.json
with the following settings:That way VSCode will ask you if you want to use the workspace version of TypeScript the first time you open a TS file in that project.
👉 Select "Allow" when VSCode asks if you want to use the workspace version of TypeScript
Otherwise, you can also manually opt-in to the workspace version:
Select TypeScript Version
Use Workspace Version
Troubleshooting
In VSCode, open up any TypeScript file in your project and then use CMD+SHIFT+P to select
Open TS Server log
.There should be a log for
[react-router] setup
that indicates that the plugin was resolved correctly.Then look for any errors in the log.
Patch Changes
react-router@7.0.0-pre.0
@react-router/serve@7.0.0-pre.0
@react-router/node@7.0.0-pre.0
react-router-dom@7.0.0-pre.0
Major Changes
Remove the original
defer
implementation in favor of using raw promises via single fetch andturbo-stream
. This removes these exports from React Router: (#11744)defer
AbortedDeferredError
type TypedDeferredData
UNSAFE_DeferredData
UNSAFE_DEFERRED_SYMBOL
,Use
createRemixRouter
/RouterProvider
inentry.client
instead ofRemixBrowser
(#11469)Remove single_fetch future flag. (#11522)
Remove
future.v7_startTransition
flag (#11696)Remove
future.v7_normalizeFormMethod
future flag (#11697)Allow returning
undefined
from actions and loaders (#11680)update minimum node version to 18 (#11690)
Remove
future.v7_prependBasename
from the ionternalized@remix-run/router
package (#11726)Remove
future.v7_throwAbortReason
from internalized@remix-run/router
package (#11728)Add
exports
field to all packages (#11675)node package no longer re-exports from react-router (#11702)
updates the minimum React version to 18 (#11689)
future.v7_partialHydration
flag (#11725)<RouterProvider fallbackElement>
propfallbackElement
to ahydrateFallbackElement
/HydrateFallback
on your root routefuture.v7_partialHydration
(when usingfallbackElement
),state.navigation
was populated during the initial loadfuture.v7_partialHydration
,state.navigation
remains in an"idle"
state during the initial loadRemove
future.v7_fetcherPersist
flag (#11731)Minor Changes
Link
/NavLink
when using Remix SSR (#11402)ScrollRestoration
so it can restore properly on an SSR'd document load (#11401)RouterProvider
. When running from a Remix-SSR'd HTML payload with the properwindow
variables (__remixContext
,__remixManifest
,__remixRouteModules
), you don't need to pass arouter
prop andRouterProvider
will create therouter
for you internally. (#11396) (#11400)Patch Changes
RouterProvider
internals to reduce uneccesary re-renders (#11817)react-router@7.0.0-pre.0
@react-router/express@7.0.0-pre.0
Major Changes
exports
field to all packages (#11675)Patch Changes
react-router@7.0.0-pre.0
@react-router/node@7.0.0-pre.0
@react-router/node@7.0.0-pre.0
Major Changes
Remove single_fetch future flag. (#11522)
For Remix consumers migrating to React Router, the
crypto
global from the Web Crypto API is now required when using cookie and session APIs. This means that the following APIs are provided fromreact-router
rather than platform-specific packages: (#11837)createCookie
createCookieSessionStorage
createMemorySessionStorage
createSessionStorage
For consumers running older versions of Node, the
installGlobals
function from@remix-run/node
has been updated to defineglobalThis.crypto
, using Node'srequire('node:crypto').webcrypto
implementation.Since platform-specific packages no longer need to implement this API, the following low-level APIs have been removed:
createCookieFactory
createSessionStorageFactory
createCookieSessionStorageFactory
createMemorySessionStorageFactory
update minimum node version to 18 (#11690)
Add
exports
field to all packages (#11675)node package no longer re-exports from react-router (#11702)
Patch Changes
react-router@7.0.0-pre.0
@react-router/serve@7.0.0-pre.0
Major Changes
exports
field to all packages (#11675)Patch Changes
Update
express.static
configurations to support prerendering (#11547)build/client/assets
folder are served as before, with a 1-year immutableCache-Control
header.html
and.data
files are not served with a specificCache-Control
header.data
files are served withContent-Type: text/x-turbo
express.static
, it seems to also add aCache-Control: public, max-age=0
to.data
filesUpdated dependencies:
react-router@7.0.0-pre.0
@react-router/express@7.0.0-pre.0
@react-router/node@7.0.0-pre.0
@react-router/fs-routes@7.0.0-pre.0
Patch Changes
@react-router/dev@7.0.0-pre.0
@react-router/remix-config-routes-adapter@7.0.0-pre.0
Patch Changes
@react-router/dev@7.0.0-pre.0