Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update dependency react-router-dom to v6 #261

Open
wants to merge 49 commits into
base: master
Choose a base branch
from
Open

Update dependency react-router-dom to v6 #261

wants to merge 49 commits into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 9, 2022 •
edited
Loading

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
react-router-dom 5.3.3 -> 6.11.0 age adoption passing confidence

Release Notes

remix-run/react-router

v6.11.0

Compare Source

Minor Changes
  • Enable basename support in useFetcher (#​10336)
    • If you were previously working around this issue by manually prepending the basename then you will need to remove the manually prepended basename from your fetcher calls (fetcher.load('/basename/route') -> fetcher.load('/route'))
Patch Changes
  • Fix inadvertent re-renders when using Component instead of element on a route definition (#​10287)
  • Fail gracefully on <Link to="//"> and other invalid URL values (#​10367)
  • Switched from useSyncExternalStore to useState for internal @remix-run/router router state syncing in <RouterProvider>. We found some subtle bugs where router state updates got propagated before other normal useState updates, which could lead to footguns in useEffect calls. (#​10377, #​10409)
  • Add static prop to StaticRouterProvider's internal Router 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 on useLocation(). When using BrowserRouter, these hooks remain unstable across location changes because they still rely on useLocation(). (#​10336)
  • Updated dependencies:
    • react-router@6.11.0
    • @remix-run/router@1.6.0

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 exposed useNavigation()/useFetcher() formMethod fields as uppercase HTTP methods to align with the fetch() behavior. (#​10207)

    • When future.v7_normalizeFormMethod === false (default v6 behavior),
      • useNavigation().formMethod is lowercase
      • useFetcher().formMethod is lowercase
    • When future.v7_normalizeFormMethod === true:
      • useNavigation().formMethod is uppercase
      • useFetcher().formMethod is uppercase
Patch Changes
  • Fix createStaticHandler to also check for ErrorBoundary on routes in addition to errorElement (#​10190)
  • Updated dependencies:
    • @remix-run/router@1.5.0
    • react-router@6.10.0

v6.9.0

Compare Source

Minor Changes

  • 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)

    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 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.

    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

v6.8.2

Compare Source

Patch Changes
  • Treat same-origin absolute URLs in <Link to> as external if they are outside of the router basename (#​10135)
  • Fix useBlocker to return IDLE_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

v6.8.1

Compare Source

Patch Changes
  • Improved absolute url detection in Link component (now also supports mailto: 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

v6.8.0

Compare Source

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 of beforeunload 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

v6.7.0

Compare Source

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

v6.6.2

Compare Source

Patch Changes
  • Ensure useId consistency during SSR (#​9805)
  • Updated dependencies:
    • react-router@6.6.2

v6.6.1

Compare Source

Patch Changes
  • Updated dependencies:
    • @remix-run/router@1.2.1
    • react-router@6.6.1

v6.6.0

Compare Source

Minor Changes
  • Add useBeforeUnload() hook (#​9664)
  • Remove unstable_ prefix from createStaticHandler/createStaticRouter/StaticRouterProvider (#​9738)
Patch Changes
  • Proper hydration of Error objects from StaticRouterProvider (#​9664)
  • Support uppercase <Form method> and useSubmit 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

v6.5.0

Compare Source

Patch Changes
  • Updated dependencies:
    • react-router@6.5.0
    • @remix-run/router@1.1.0

v6.4.5

Compare Source

Patch Changes
  • Updated dependencies:
    • @remix-run/router@1.0.5
    • react-router@6.4.5

v6.4.4

Compare Source

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

v6.4.3

Compare Source

Patch Changes
  • Fix hrefs generated for createHashRouter (#​9409)
  • fix encoding/matching issues with special chars (#​9477, #​9496)
  • Properly support index routes with a path in useResolvedPath (#​9486)
  • Respect relative=path prop on NavLink (#​9453)
  • Fix NavLink behavior for root urls (#​9497)
  • Updated dependencies:
    • @remix-run/router@1.0.3
    • react-router@6.4.3

v6.4.2

Compare Source

Patch Changes
  • Respect basename in useFormAction (#​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

v6.4.1

Compare Source

Patch Changes
  • Updated dependencies:
    • react-router@6.4.1
    • @remix-run/router@1.0.1

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

  • Create your router with createMemoryRouter/createBrowserRouter/createHashRouter
  • Render your router with <RouterProvider>
  • Load data with a Route loader and mutate with a Route action
  • 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 and Await
  • 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

v6.3.0: react-router@v6.3.0

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
  • Fixed nested splat routes that begin with special URL-safe characters (#​8563)
  • Fixed a bug where index routes were missing route context in some cases (#​8497)

New Contributors

Full Changelog: remix-run/react-router@v6.2.1...v6.2.2

v6.2.1

Compare Source

This release updates the internal history dependency to 5.2.0.

Full Changelog: remix-run/react-router@v6.2.0...v6.2.1

v6.2.0

Compare Source

🐛 Bug fixes

  • Fixed the RouteProps element type, which should be a ReactNode (#​8473)
  • Fixed a bug with useOutlet for top-level routes (#​8483)

✨ Features

  • We now use statically analyzable CJS exports. This enables named imports in Node ESM scripts (See the commit).

New Contributors

Full Changelog: remix-run/react-router@v6.1.1...v6.2.0

v6.1.1

Compare Source

In v6.1.0 we inadvertently shipped a new, undocumented API that will likely introduce bugs (#​7586). We have flagged HistoryRouter as unstable_HistoryRouter, as this API will likely need to change before a new major release.

Full Changelog: remix-run/react-router@v6.1.0...v6.1.1

v6.1.0

Compare Source

🐛 Bug fixes

  • Fixed a bug that broke support for base64 encoded IDs on nested routes (#​8291)

✨ Features

  • <Outlet> can now receive a context prop. This value is passed to child routes and is accessible via the new useOutletContext hook. See the API docs for details. (#​8461)
  • <NavLink> can now receive a child function for access to its props. (#​8164)

💅 Enhancements

  • Improved TypeScript signature for useMatch and matchPath. For example, when you call useMatch("foo/:bar/:baz"), the path is parsed and the return type will be PathMatch<"bar" | "baz">. (#​8030)
  • A few error message improvements (#​8202)

New Contributors

Full Changelog: remix-run/react-router@v6.0.1...v6.1.0

v6.0.2

Compare Source

✨ Features

  • Added the reloadDocument prop to <Link>. This allows <Link> to function like a normal anchor tag by reloading the document after navigation while maintaining the relative to resolution.

🗒️ Docs

  • Fixed several issues in docblocks and the docs themselves. See the full changelog for the deets!

🤝 New Contributors

Full Changelog

v6.0.1

Compare Source

🐛 Bug Fixes

  • Add a default <StaticRouter location> value (#​8243)
  • Add invariant for using <Route> inside <Routes> to help people make the change (#​8238)

v6.0.0

Compare Source

React Router v6 is here!

Please go read our blog post for more information on all the great stuff in v6 including notes about how to upgrade from React Router v5 and Reach Router.

v5.3.4

Compare Source

We removed the mini-create-react-context dependency, moving it into an internal module to eliminate peer dependency warnings for users on React 18 (#​9382).

Full Changelog: remix-run/react-router@v5.3.3...v5.3.4

Configuration

📅 Schedule: Branch creation - "before 3am on Monday" in timezone Asia/Tokyo, 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.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot added the renovate label Jan 9, 2022
@github-actions github-actions bot temporarily deployed to commit January 9, 2022 17:03 Inactive
@github-actions github-actions bot temporarily deployed to pull request January 9, 2022 17:03 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 5201391 to 4532ccd Compare January 9, 2022 18:16
@github-actions github-actions bot temporarily deployed to commit January 9, 2022 18:17 Inactive
@github-actions github-actions bot temporarily deployed to pull request January 9, 2022 18:18 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 4532ccd to a52e6cb Compare January 16, 2022 18:54
@github-actions github-actions bot temporarily deployed to commit January 16, 2022 18:56 Inactive
@github-actions github-actions bot temporarily deployed to pull request January 16, 2022 18:56 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from a52e6cb to c08c687 Compare January 16, 2022 20:48
@github-actions github-actions bot temporarily deployed to commit January 16, 2022 20:50 Inactive
@github-actions github-actions bot temporarily deployed to pull request January 16, 2022 20:50 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from c08c687 to 229771d Compare January 23, 2022 19:06
@github-actions github-actions bot temporarily deployed to commit January 23, 2022 19:08 Inactive
@github-actions github-actions bot temporarily deployed to pull request January 23, 2022 19:08 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 229771d to 8ced746 Compare January 23, 2022 20:38
@github-actions github-actions bot temporarily deployed to commit January 23, 2022 20:39 Inactive
@github-actions github-actions bot temporarily deployed to pull request January 23, 2022 20:39 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 8ced746 to c53147a Compare January 30, 2022 15:45
@github-actions github-actions bot temporarily deployed to commit January 30, 2022 15:46 Inactive
@github-actions github-actions bot temporarily deployed to pull request January 30, 2022 15:47 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from c53147a to c36dade Compare January 30, 2022 17:26
@github-actions github-actions bot temporarily deployed to pull request January 30, 2022 17:28 Inactive
@github-actions github-actions bot temporarily deployed to commit January 30, 2022 17:28 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from c36dade to 2666882 Compare January 31, 2022 18:15
@github-actions github-actions bot temporarily deployed to pull request January 31, 2022 18:17 Inactive
@github-actions github-actions bot temporarily deployed to commit January 31, 2022 18:17 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 2666882 to 6e98991 Compare February 6, 2022 18:37
@github-actions github-actions bot temporarily deployed to pull request February 6, 2022 18:39 Inactive
@github-actions github-actions bot temporarily deployed to commit February 6, 2022 18:39 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 0efed43 to 00647ab Compare November 26, 2022 18:34
@github-actions github-actions bot temporarily deployed to commit November 26, 2022 18:35 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 00647ab to 57f13b5 Compare November 27, 2022 04:54
@github-actions github-actions bot temporarily deployed to commit November 27, 2022 04:55 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 57f13b5 to 343c56a Compare November 30, 2022 22:40
@github-actions github-actions bot temporarily deployed to commit November 30, 2022 22:42 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 343c56a to 26b8ac3 Compare December 7, 2022 21:12
@github-actions github-actions bot temporarily deployed to commit December 7, 2022 21:14 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 26b8ac3 to fbe358f Compare December 16, 2022 19:00
@github-actions github-actions bot temporarily deployed to commit December 16, 2022 19:01 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from fbe358f to 484eec1 Compare December 21, 2022 19:48
@github-actions github-actions bot temporarily deployed to commit December 21, 2022 19:50 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 484eec1 to 54fefea Compare December 23, 2022 16:55
@github-actions github-actions bot temporarily deployed to commit December 23, 2022 16:57 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 54fefea to 9f18426 Compare January 9, 2023 21:59
@github-actions github-actions bot temporarily deployed to commit January 9, 2023 22:01 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 9f18426 to e65b574 Compare January 18, 2023 22:54
@github-actions github-actions bot temporarily deployed to commit January 18, 2023 22:57 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from e65b574 to a7b7278 Compare January 26, 2023 21:28
@github-actions github-actions bot temporarily deployed to commit January 26, 2023 21:31 Inactive
@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from a7b7278 to 3a64a47 Compare March 16, 2023 09:51
@github-actions github-actions bot temporarily deployed to commit March 16, 2023 09:53 Inactive
@renovate
Copy link
Contributor Author

renovate bot commented Mar 24, 2023 •
edited
Loading

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

@renovate renovate bot force-pushed the renovate/major-react-router-monorepo branch from 3a64a47 to 625cb62 Compare April 30, 2023 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
renovate
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@vipzero @renovate-bot