Skip to content

Latest commit

 

History

History
396 lines (259 loc) · 9.37 KB

CHANGELOG.md

File metadata and controls

396 lines (259 loc) · 9.37 KB
Raw

react-router-native

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 the Dashboard 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 the Dashboard 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 route action 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 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:
    • react-router@6.21.0

6.20.1

Patch Changes

  • Updated dependencies:
    • react-router@6.20.1

6.20.0

Minor Changes

  • Export the PathParam type from the public API (#10719)

Patch Changes

  • Updated dependencies:
    • react-router@6.20.0

6.19.0

Patch Changes

  • Updated dependencies:
    • react-router@6.19.0

6.18.0

Patch Changes

  • Updated dependencies:
    • react-router@6.18.0

6.17.0

Patch Changes

  • Updated dependencies:
    • react-router@6.17.0

6.16.0

Minor Changes

  • Updated dependencies:
    • react-router@6.16.0

6.15.0

Minor Changes

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

Patch Changes

  • Update @ungap/url-search-params dependency from ^0.1.4 to ^0.2.2 (#10590)
  • Updated dependencies:
    • react-router@6.15.0

6.14.2

Patch Changes

  • Updated dependencies:
    • react-router@6.14.2

6.14.1

Patch Changes

  • Updated dependencies:
    • react-router@6.14.1

6.14.1-pre.1

Patch Changes

  • Updated dependencies:
    • react-router@6.14.1-pre.1

6.14.1-pre.0

Patch Changes

  • Updated dependencies:
    • react-router@6.14.1-pre.0

6.14.0

Patch Changes

  • Upgrade typescript to 5.1 (#10581)
  • Updated dependencies:
    • react-router@6.14.0

6.13.0

Patch Changes

  • Updated dependencies:
    • react-router@6.13.0

6.12.1

Patch Changes

  • Updated dependencies:
    • react-router@6.12.1

6.12.0

Patch Changes

  • Updated dependencies:
    • react-router@6.12.0

6.11.2

Patch Changes

  • Export SetURLSearchParams type (#10444)
  • Updated dependencies:
    • react-router@6.11.2

6.11.1

Patch Changes

  • Updated dependencies:
    • react-router@6.11.1

6.11.0

Patch Changes

  • Updated dependencies:
    • react-router@6.11.0

6.10.0

Patch Changes

  • Updated dependencies:
    • react-router@6.10.0

6.9.0

Minor Changes

  • Updated dependencies:
    • react-router@6.9.0

6.8.2

Patch Changes

  • Updated dependencies:
    • react-router@6.8.2

6.8.1

Patch Changes

  • Updated dependencies:
    • react-router@6.8.1

6.8.0

Patch Changes

  • Fix bug with search params removal via useSearchParams (#9969)
  • Updated dependencies:
    • react-router@6.8.0

6.7.0

Patch Changes

  • Updated dependencies:
    • react-router@6.7.0

6.6.2

Patch Changes

  • Updated dependencies:
    • react-router@6.6.2

6.6.1

Patch Changes

  • Updated dependencies:
    • react-router@6.6.1

6.6.0

Patch Changes

  • Updated dependencies:
    • react-router@6.6.0

6.5.0

Patch Changes

  • Updated dependencies:
    • react-router@6.5.0

6.4.5

Patch Changes

  • Updated dependencies:
    • react-router@6.4.5

6.4.4

Patch Changes

  • Updated dependencies:
    • react-router@6.4.4

6.4.3

Patch Changes

  • Updated dependencies:
    • react-router@6.4.3

6.4.2

Patch Changes

  • 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

6.4.1

Patch Changes

  • Updated dependencies:
    • react-router@6.4.1

6.4.0

Bug Fixes

  • Path resolution is now trailing slash agnostic (#8861)
  • useLocation returns the scoped location inside a <Routes location> component (#9094)

Updated dependencies

  • react-router@6.4.0