fix(deps): update dependency history to version 5.x 🌟 (major) #1505
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 contains the following updates:
4.10.1
->5.3.0
5.3.4
->6.26.2
5.3.4
->6.26.2
Release Notes
remix-run/history (history)
v5.3.0
Compare Source
This release provides support for native ESM consumption of all exports.
v5.2.0
Compare Source
🐛 Bug fixes
State
(now set tounknown
which will require consumer type narrowing)PartialPath
(usePartial<Path>
instead)PartialLocation
(usePartial<Location>
instead)createPath
return value (#813)✨ Features
Full Changelog: remix-run/history@v5.1.0...v5.2.0
v5.1.0
Compare Source
Because the prior 5.0.2 release removed the
State
type parameter fromLocation
, this was technically a breaking change. To correct for this, I'm bumping this as a minor release. It won't affect runtime code, but it may affect your development experience and tests if you were using that parameter.The
State
type export is also restored, so you shouldn't have issues with installing React Router v6.Oh, by the way, did you hear we released React Router v6?
Full Changelog: remix-run/history@v5.0.3...v5.1.0
v5.0.3
Compare Source
Fixed
parsePath
adding incorrectly addingsearch
v5.0.2
Compare Source
Just a couple fixes:
location.state
type toany
and removed the generic onLocation
Full Changelog: remix-run/history@v5.0.1...v5.0.2
v5.0.1
Compare Source
This patch release contains a tiny TypeScript update to use the built-in
Partial
utility forPartialPath
andPartialLocation
. We always love it when we can ship just a little less code!🙏 Credits
Thanks to @liuhanqu, @hanquliu, @chaance and @mjackson for your contributions!
v5.0.0
Compare Source
Today we are very pleased to announce the stable release of history version 5!
Overview
This version includes many enhancements and fixes a few important issues with the library.
New Features
location.state
history.block
API, with support for retrying transitions<script type=module>
userswindow
objects)Bugfixes
location.pathname
HistoryLibrary
so it doesn't conflict withwindow.History
Breaking Changes
pushState
)getUserConfirmation
,keyLength
, andhashType
APIsUsage
Please refer to our installation guide for instructions about how to install the library.
There is also a getting started guide as well as a complete API reference in the
docs
folder.We are very excited about this release, especially because it will serve as the foundation for the upcoming release of React Router version 6.
Thank you for your support. Enjoy! 😀
remix-run/react-router (react-router)
v6.26.2
Compare Source
Patch Changes
@remix-run/[email protected]
v6.26.1
Compare Source
v6.26.0
Compare Source
Minor Changes
replace(url, init?)
alternative toredirect(url, init?)
that performs ahistory.replaceState
instead of ahistory.pushState
on client-side navigation redirects (#11811)Patch Changes
future.v7_partialHydration
along withunstable_patchRoutesOnMiss
(#11838)router.state.matches
will now include any partial matches so that we can render ancestorHydrateFallback
components@remix-run/[email protected]
v6.25.1
: v6.25.1Compare Source
See the changelog for release notes: https://github.com/remix-run/react-router/blob/main/CHANGELOG.md#v6251
v6.25.0
Compare Source
Minor Changes
Stabilize
future.unstable_skipActionErrorRevalidation
asfuture.v7_skipActionErrorRevalidation
(#11769)Response
with a4xx
/5xx
status codeshouldRevalidate
shouldRevalidate
'sunstable_actionStatus
parameter toactionStatus
Patch Changes
useMatch
so matches/params reflect decoded params (#11789)@remix-run/[email protected]
v6.24.1
Compare Source
Patch Changes
future.v7_relativeSplatPath
, properly resolve relative paths in splat routes that are children of pathless routes (#11633)@remix-run/[email protected]
v6.24.0
Compare Source
Minor Changes
Add support for Lazy Route Discovery (a.k.a. Fog of War) (#11626)
unstable_patchRoutesOnMiss
docs: https://reactrouter.com/en/main/routers/create-browser-routerPatch Changes
@remix-run/[email protected]
v6.23.1
Compare Source
Patch Changes
<Await>
(#11513)@remix-run/[email protected]
v6.23.0
Compare Source
Minor Changes
unstable_dataStrategy
configuration option (#11098)Patch Changes
@remix-run/[email protected]
v6.22.3
Compare Source
Patch Changes
@remix-run/[email protected]
v6.22.2
Compare Source
Patch Changes
@remix-run/[email protected]
v6.22.1
: v6.22.1Compare Source
See the changelog for release notes: https://github.com/remix-run/react-router/blob/main/CHANGELOG.md#v6221
v6.22.0
Compare Source
Patch Changes
@remix-run/[email protected]
v6.21.3
Compare Source
Patch Changes
unstable_
prefix fromBlocker
/BlockerFunction
types (#11187)v6.21.2
Compare Source
v6.21.1
Compare Source
Patch Changes
route.lazy
not working correctly on initial SPA load whenv7_partialHydration
is specified (#11121)@remix-run/[email protected]
v6.21.0
Compare Source
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:Any paths like
/dashboard
,/dashboard/team
,/dashboard/projects
will match theDashboard
route. The dashboard component itself can then render nested<Routes>
: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"."
: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:
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: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: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
@remix-run/[email protected]
v6.20.1
Compare Source
Patch Changes
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)@remix-run/[email protected]
v6.20.0
Compare Source
Minor Changes
PathParam
type from the public API (#10719)Patch Changes
resolveTo
in splat routes (#11045)getPathContributingMatches
UNSAFE_getPathContributingMatches
export from@remix-run/router
since we no longer need this in thereact-router
/react-router-dom
layers@remix-run/[email protected]
v6.19.0
Compare Source
Minor Changes
unstable_flushSync
option touseNavigate
/useSumbit
/fetcher.load
/fetcher.submit
to opt-out ofReact.startTransition
and intoReactDOM.flushSync
for state updates (#11005)unstable_
prefix from theuseBlocker
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 fromunstable_usePrompt
due to differences in how browsers handlewindow.confirm
that prevent React Router from guaranteeing consistent/correct behavior. (#10991)Patch Changes
Fix
useActionData
so it returns proper contextual action data and not any action data in the tree (#11023)Fix bug in
useResolvedPath
that would causeuseResolvedPath(".")
in a splat route to lose the splat portion of the URL path. (#10983)"."
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/[email protected]
v6.18.0
Compare Source
Patch Changes
future
prop onBrowserRouter
,HashRouter
andMemoryRouter
so that it accepts aPartial<FutureConfig>
instead of requiring all flags to be included. (#10962)@remix-run/[email protected]
v6.17.0
Compare Source
Patch Changes
RouterProvider
future
prop type to be aPartial<FutureConfig>
so that not all flags must be specified (#10900)@remix-run/[email protected]
v6.16.0
Compare Source
Minor Changes
any
withunknown
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 toany
in React Router and are overridden withunknown
in Remix. In React Router v7 we plan to move these tounknown
as a breaking change. (#10843)Location
now accepts a generic for thelocation.state
valueActionFunctionArgs
/ActionFunction
/LoaderFunctionArgs
/LoaderFunction
now accept a generic for thecontext
parameter (only used in SSR usages viacreateStaticHandler
)useMatches
(now exported asUIMatch
) accepts generics formatch.data
andmatch.handle
- both of which were already set tounknown
@private
class exportErrorResponse
to anUNSAFE_ErrorResponseImpl
export since it is an implementation detail and there should be no construction ofErrorResponse
instances in userland. This frees us up to export atype ErrorResponse
which correlates to an instance of the class viaInstanceType
. Userland code should only ever be usingErrorResponse
as a type and should be type-narrowing viaisRouteErrorResponse
. (#10811)ShouldRevalidateFunctionArgs
interface (#10797)_isFetchActionRedirect
,_hasFetcherDoneAnything
) (#10715)Patch Changes
@remix-run/[email protected]
v6.15.0
Compare Source
Minor Changes
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
useRevalidator
is referentially stable across re-renders if revalidations are not actively occurring (#10707)@remix-run/[email protected]
v6.14.2
Compare Source
Patch Changes
@remix-run/[email protected]
v6.14.1
Compare Source
Patch Changes
unstable_useBlocker
when used with an unstable blocker function (#10652)@remix-run/[email protected]
v6.14.0
Compare Source
Patch Changes
basename
from locations provided tounstable_useBlocker
functions to matchuseLocation
(#10573)generatePath
when passed a numeric0
value parameter (#10612)unstable_useBlocker
key issues inStrictMode
(#10573)tsc --skipLibCheck:false
issues on React 17 (#10622)typescript
to 5.1 (#10581)@remix-run/[email protected]
v6.13.0
Compare Source
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
:If you wish to enable
React.startTransition
, pass the future flag to your component:Patch Changes
React.startTransition
minification bug in production mode (#10588)v6.12.1
Compare Source
Patch Changes
React.startTransition
to fix webpack + react 17 compilation error (#10569)v6.12.0
Compare Source
Minor Changes
React.startTransition
if it exists (#10438)Patch Changes
@remix-run/[email protected]
v6.11.2
Compare Source
Patch Changes
basename
duplication in descendant<Routes>
inside a<RouterProvider>
(#10492)@remix-run/[email protected]
v6.11.1
Compare Source
Patch Changes
Component
API within descendant<Routes>
(#10434)useNavigate
from<Routes>
inside a<RouterProvider>
(#10432)<Navigate>
in strict mode when using a data router (#10435)@remix-run/[email protected]
v6.11.0
Compare Source
Patch Changes
<Routes>
whenRouterProvider
errors existed (#10374)Component
instead ofelement
on a route definition (#10287)useNavigate
in the render cycle by setting theactiveRef
in a layout effect, allowing thenavigate
function to be passed to child components and called in auseEffect
there. (#10394)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)useRevalidator()
to resolve a loader-driven error boundary scenario (#10369)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)@remix-run/[email protected]
v6.10.0
Compare Source
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)future.v7_normalizeFormMethod === false
(default v6 behavior),useNavigation().formMethod
is lowercaseuseFetcher().formMethod
is lowercasefuture.v7_normalizeFormMethod === true
:useNavigation().formMethod
is uppercaseuseFetcher().formMethod
is uppercasePatch Changes
createRoutesFromElements
(#10193)@remix-run/[email protected]
v6.9.0
Compare Source
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
Example JSX Syntax
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.Then in your lazy route modules, export the properties you want defined for the route:
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:
@remix-run/[email protected]
Patch Changes
generatePath
incorrectly applying parameters in some cases (#10078)v6.8.2
Compare Source
Patch Changes
@remix-run/[email protected]
v6.8.1
Compare Source
Patch Changes
@remix-run/[email protected]
v6.8.0
Compare Source
Patch Changes
@remix-run/[email protected]
v6.7.0
Compare Source
Minor Changes
unstable_useBlocker
hook for blocking navigations within the app's location origin (#9709)Patch Changes
generatePath
when optional params are present (#9764)<Await>
to acceptReactNode
as children function return result (#9896)@remix-run/[email protected]
v6.6.2
Compare Source
Patch Changes
useId
consistency during SSR (#9805)v6.6.1
Compare Source
Patch Changes
@remix-run/[email protected]
v6.6.0
Compare Source
Patch Changes
useLoaderData
usage inerrorElement
(#9735)@remix-run/[email protected]
v6.5.0
Compare Source
This release introduces support for Optional Route Segments. 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.Optional Params Examples
<Route path=":lang?/about>
will match:/:lang/about
/about
<Route path="/multistep/:widget1?/widget2?/widget3?">
will match:/multistep
/multistep/:widget1
/multistep/:widget1/:widget2
/multistep/:widget1/:widget2/:widget3
Optional Static Segment Example
<Route path="/home?">
will match:/
/home
<Route path="/fr?/about">
will match:/about
/fr/about
Minor Changes
Patch Changes
<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 theuseParams
call site: (#9506)@remix-run/[email protected]
v6.4.5
Compare Source
Patch Changes
@remix-run/[email protected]
v6.4.4
Compare Source
Patch Changes
@remix-run/[email protected]
v6.4.3
Compare Source
Patch Changes
useRoutes
should be able to returnnull
when passinglocationArg
(#9485)initialEntries
type increateMemoryRouter
(#9498)@remix-run/[email protected]
v6.4.2
Compare Source
Patch Changes
IndexRouteObject
andNonIndexRouteObject
types to makehasErrorElement
optional (#9394)RouteObject
/RouteProps
types to surface the error in TypeScript. (#9366)@remix-run/[email protected]
v6.4.1
Compare Source
Patch Changes
initialEntries
(#9288)@remix-run/[email protected]
v6.4.0
Compare Source
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
createMemoryRouter
<RouterProvider>
loader
and mutate with a Routeaction
errorElement
defer
andAwait
Bug Fixes
useLocation
returns the scoped location inside a<Routes location>
component (#9094)Updated Dependencies
@remix-run/[email protected]
v6.3.0
: [email protected]Compare Source
What's Changed
New Contributors
Full Changelog: remix-run/react-router@v6.2.2...v6.3.0
v6.2.2
Compare Source
What's Changed
🐛 Bug Fixes
New Contributors
Configuration
📅 Schedule: Branch creation - "before 3am on the first day of the month" in timezone America/New_York, Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR was generated by Mend Renovate. View the repository job log.