@remix-run/router

1.19.2

Patch Changes

1.19.1

Patch Changes

1.19.0

Minor Changes

Patch Changes

1.18.0

Minor Changes

Patch Changes

1.17.1

Patch Changes

1.17.0

Minor Changes

1.16.1

Patch Changes

1.16.0

Minor Changes

1.15.3

Patch Changes

1.15.2

Patch Changes

1.15.1

Patch Changes

1.15.0

Minor Changes

Patch Changes

1.14.2

Patch Changes

1.14.1

Patch Changes

1.14.0

Minor Changes

For example, the following router has a root and index route, but only provided hydrationData.loaderData for the root route. Because the index route has a loader, we need to run that during initialization. With future.v7_partialHydration specified, <RouterProvider> will render the RootComponent (because it has data) and then the IndexFallback (since it does not have data). Once indexLoader finishes, application will update and display IndexComponent.

jsx let router = createBrowserRouter( [ { id: "root", path: "/", loader: rootLoader, Component: RootComponent, Fallback: RootFallback, children: [ { id: "index", index: true, loader: indexLoader, Component: IndexComponent, HydrateFallback: IndexFallback, }, ], }, ], { future: { v7_partialHydration: true, }, hydrationData: { loaderData: { root: { message: "Hydrated from Root!" }, }, }, } );

If the above example did not have an IndexFallback, then RouterProvider would instead render the RootFallback while it executed the indexLoader.

Note: When future.v7_partialHydration is provided, the <RouterProvider fallbackElement> prop is ignored since you can move it to a Fallback on your top-most route. The fallbackElement prop will be removed in React Router v7 when v7_partialHydration behavior becomes the standard behavior.

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:

jsx <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>:

```jsx function Dashboard() { return (

Dashboard

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

```jsx // If we are on URL /dashboard/team, and we want to link to /dashboard/team: function DashboardTeam() { // ❌ This is broken and results in return A broken link to the Current URL;

// ✅ 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:

jsx <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:

jsx 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:

```jsx } />

function Dashboard() { return (

Dashboard

    <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

1.13.1

Patch Changes

1.13.0

Minor Changes

Patch Changes

1.12.0

Minor Changes

Patch Changes

```jsx }> ;

function Component() { return ( <> {/ This is now correctly relative to /a/b, not /a/b/c /}
); } ```

1.11.0

Minor Changes

Patch Changes

1.10.0

Minor Changes

Patch Changes

1.9.0

Minor Changes

Patch Changes

1.8.0

Minor Changes

Patch Changes

1.7.2

Patch Changes

1.7.1

Patch Changes

1.7.0

Minor Changes

```js // By default, the encoding is "application/x-www-form-urlencoded" router.navigate("/", { formMethod: "post", body: { key: "value" }, });

async function action({ request }) { // await request.formData() => FormData instance with entry [key=value] } ```

``js // PassformEncType` to opt-into a different encoding (json) router.navigate("/", { formMethod: "post", formEncType: "application/json", body: { key: "value" }, });

async function action({ request }) { // await request.json() => { key: "value" } } ```

``js // PassformEncType` to opt-into a different encoding (text) router.navigate("/", { formMethod: "post", formEncType: "text/plain", body: "Text submission", });

async function action({ request }) { // await request.text() => "Text submission" } ```

Patch Changes

1.6.3

Patch Changes

1.6.2

Patch Changes

1.6.1

Patch Changes

1.6.0

Minor Changes

Patch Changes

1.5.0

Minor Changes

Patch Changes

1.4.0

Minor Changes

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.

jsx // 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:

```jsx 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) ? (

{error.status} {error.statusText}

) : (

{error.message || error}

); } ```

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.

Patch Changes

1.3.3

Patch Changes

1.3.2

Patch Changes

1.3.1

Patch Changes

1.3.0

Minor Changes

Patch Changes

1.2.1

Patch Changes

1.2.0

Minor Changes

Patch Changes

1.1.0

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

Optional Static Segment Example

Minor Changes

Patch Changes

```jsx // Old behavior at URL /prefix-123 }>

function Comp() { let params = useParams(); // { id: '123' } let id = params.id; // "123" ... }

// New behavior at URL /prefix-123 }>

function Comp() { let params = useParams(); // { id: 'prefix-123' } let id = params.id.replace(/^prefix-/, ''); // "123" ... } ```

1.0.5

Patch Changes

1.0.4

Patch Changes

1.0.3

Patch Changes

1.0.2

Patch Changes

1.0.1

Patch Changes

1.0.0

This is the first stable release of @remix-run/router, which provides all the underlying routing and data loading/mutation logic for react-router. You should not be using this package directly unless you are authoring a routing library similar to react-router.

For an overview of the features provided by react-router, we recommend you go check out the docs, especially the feature overview and the tutorial.

For an overview of the features provided by @remix-run/router, please check out the README.