react-router-dom 6.23.1 → 6.24.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # `react-router-dom`
 
+## 6.24.0
+
+### Minor Changes
+
+- Add support for Lazy Route Discovery (a.k.a. Fog of War) ([#11626](https://github.com/remix-run/react-router/pull/11626))
+
+  - RFC: <https://github.com/remix-run/react-router/discussions/11113>
+  - `unstable_patchRoutesOnMiss` docs: <https://reactrouter.com/en/main/routers/create-browser-router>
+
+### Patch Changes
+
+- Fix `fetcher.submit` types - remove incorrect `navigate`/`fetcherKey`/`unstable_viewTransition` options because they are only relevant for `useSubmit` ([#11631](https://github.com/remix-run/react-router/pull/11631))
+- Allow falsy `location.state` values passed to `<StaticRouter>` ([#11495](https://github.com/remix-run/react-router/pull/11495))
+- Updated dependencies:
+  - `react-router@6.24.0`
+  - `@remix-run/router@1.17.0`
+
 ## 6.23.1
 
 ### Patch Changes

package/dist/dom.d.ts

@@ -40,7 +40,10 @@ type JsonArray = JsonValue[] | readonly JsonValue[];
 type JsonPrimitive = string | number | boolean | null;
 type JsonValue = JsonPrimitive | JsonObject | JsonArray;
 export type SubmitTarget = HTMLFormElement | HTMLButtonElement | HTMLInputElement | FormData | URLSearchParams | JsonValue | null;
-export interface SubmitOptions {
+/**
+ * Submit options shared by both navigations and fetchers
+ */
+interface SharedSubmitOptions {
     /**
      * The HTTP method used to submit the form. Overrides `<form method>`.
      * Defaults to "GET".
@@ -57,13 +60,30 @@ export interface SubmitOptions {
      */
     encType?: FormEncType;
     /**
-     * Indicate a specific fetcherKey to use when using navigate=false
+     * Determines whether the form action is relative to the route hierarchy or
+     * the pathname.  Use this if you want to opt out of navigating the route
+     * hierarchy and want to instead route based on /-delimited URL segments
      */
-    fetcherKey?: string;
+    relative?: RelativeRoutingType;
     /**
-     * navigate=false will use a fetcher instead of a navigation
+     * In browser-based environments, prevent resetting scroll after this
+     * navigation when using the <ScrollRestoration> component
      */
-    navigate?: boolean;
+    preventScrollReset?: boolean;
+    /**
+     * Enable flushSync for this submission's state updates
+     */
+    unstable_flushSync?: boolean;
+}
+/**
+ * Submit options available to fetchers
+ */
+export interface FetcherSubmitOptions extends SharedSubmitOptions {
+}
+/**
+ * Submit options available to navigations
+ */
+export interface SubmitOptions extends FetcherSubmitOptions {
     /**
      * Set `true` to replace the current entry in the browser's history stack
      * instead of creating a new one (i.e. stay on "the same page"). Defaults
@@ -75,20 +95,13 @@ export interface SubmitOptions {
      */
     state?: any;
     /**
-     * Determines whether the form action is relative to the route hierarchy or
-     * the pathname.  Use this if you want to opt out of navigating the route
-     * hierarchy and want to instead route based on /-delimited URL segments
-     */
-    relative?: RelativeRoutingType;
-    /**
-     * In browser-based environments, prevent resetting scroll after this
-     * navigation when using the <ScrollRestoration> component
+     * Indicate a specific fetcherKey to use when using navigate=false
      */
-    preventScrollReset?: boolean;
+    fetcherKey?: string;
     /**
-     * Enable flushSync for this navigation's state updates
+     * navigate=false will use a fetcher instead of a navigation
      */
-    unstable_flushSync?: boolean;
+    navigate?: boolean;
     /**
      * Enable view transitions on this submission navigation
      */

package/dist/index.d.ts

@@ -3,14 +3,14 @@
  * you'll need to update the rollup config for react-router-dom-v5-compat.
  */
 import * as React from "react";
-import type { FutureConfig, Location, NavigateOptions, RelativeRoutingType, RouteObject, RouterProviderProps, To } from "react-router";
+import type { FutureConfig, Location, NavigateOptions, RelativeRoutingType, RouteObject, RouterProviderProps, To, unstable_PatchRoutesOnMissFunction } from "react-router";
 import type { unstable_DataStrategyFunction, unstable_DataStrategyFunctionArgs, unstable_DataStrategyMatch, Fetcher, FormEncType, FormMethod, FutureConfig as RouterFutureConfig, GetScrollRestorationKeyFunction, History, HTMLFormMethod, HydrationState, Router as RemixRouter, V7_FormMethod, BlockerFunction } from "@remix-run/router";
 import { UNSAFE_ErrorResponseImpl as ErrorResponseImpl } from "@remix-run/router";
-import type { SubmitOptions, ParamKeyValuePair, URLSearchParamsInit, SubmitTarget } from "./dom";
+import type { SubmitOptions, ParamKeyValuePair, URLSearchParamsInit, SubmitTarget, FetcherSubmitOptions } from "./dom";
 import { createSearchParams } from "./dom";
 export type { unstable_DataStrategyFunction, unstable_DataStrategyFunctionArgs, unstable_DataStrategyMatch, FormEncType, FormMethod, GetScrollRestorationKeyFunction, ParamKeyValuePair, SubmitOptions, URLSearchParamsInit, V7_FormMethod, };
 export { createSearchParams, ErrorResponseImpl as UNSAFE_ErrorResponseImpl };
-export type { ActionFunction, ActionFunctionArgs, AwaitProps, Blocker, BlockerFunction, DataRouteMatch, DataRouteObject, ErrorResponse, Fetcher, FutureConfig, Hash, IndexRouteObject, IndexRouteProps, JsonFunction, LazyRouteFunction, LayoutRouteProps, LoaderFunction, LoaderFunctionArgs, Location, MemoryRouterProps, NavigateFunction, NavigateOptions, NavigateProps, Navigation, Navigator, NonIndexRouteObject, OutletProps, Params, ParamParseKey, Path, PathMatch, Pathname, PathParam, PathPattern, PathRouteProps, RedirectFunction, RelativeRoutingType, RouteMatch, RouteObject, RouteProps, RouterProps, RouterProviderProps, RoutesProps, Search, ShouldRevalidateFunction, ShouldRevalidateFunctionArgs, To, UIMatch, unstable_HandlerResult, } from "react-router";
+export type { ActionFunction, ActionFunctionArgs, AwaitProps, Blocker, BlockerFunction, DataRouteMatch, DataRouteObject, ErrorResponse, Fetcher, FutureConfig, Hash, IndexRouteObject, IndexRouteProps, JsonFunction, LazyRouteFunction, LayoutRouteProps, LoaderFunction, LoaderFunctionArgs, Location, MemoryRouterProps, NavigateFunction, NavigateOptions, NavigateProps, Navigation, Navigator, NonIndexRouteObject, OutletProps, Params, ParamParseKey, Path, PathMatch, Pathname, PathParam, PathPattern, PathRouteProps, RedirectFunction, RelativeRoutingType, RouteMatch, RouteObject, RouteProps, RouterProps, RouterProviderProps, RoutesProps, Search, ShouldRevalidateFunction, ShouldRevalidateFunctionArgs, To, UIMatch, unstable_HandlerResult, unstable_PatchRoutesOnMissFunction, } from "react-router";
 export { AbortedDeferredError, Await, MemoryRouter, Navigate, NavigationType, Outlet, Route, Router, Routes, createMemoryRouter, createPath, createRoutesFromChildren, createRoutesFromElements, defer, isRouteErrorResponse, generatePath, json, matchPath, matchRoutes, parsePath, redirect, redirectDocument, renderMatches, resolvePath, useActionData, useAsyncError, useAsyncValue, useBlocker, useHref, useInRouterContext, useLoaderData, useLocation, useMatch, useMatches, useNavigate, useNavigation, useNavigationType, useOutlet, useOutletContext, useParams, useResolvedPath, useRevalidator, useRouteError, useRouteLoaderData, useRoutes, } from "react-router";
 /** @internal */
 export { UNSAFE_DataRouterContext, UNSAFE_DataRouterStateContext, UNSAFE_NavigationContext, UNSAFE_LocationContext, UNSAFE_RouteContext, UNSAFE_useRouteId, } from "react-router";
@@ -26,6 +26,7 @@ interface DOMRouterOpts {
     future?: Partial<Omit<RouterFutureConfig, "v7_prependBasename">>;
     hydrationData?: HydrationState;
     unstable_dataStrategy?: unstable_DataStrategyFunction;
+    unstable_patchRoutesOnMiss?: unstable_PatchRoutesOnMissFunction;
     window?: Window;
 }
 export declare function createBrowserRouter(routes: RouteObject[], opts?: DOMRouterOpts): RemixRouter;
@@ -120,7 +121,10 @@ export interface NavLinkProps extends Omit<LinkProps, "className" | "style" | "c
  * A `<Link>` wrapper that knows if it's "active" or not.
  */
 export declare const NavLink: React.ForwardRefExoticComponent<NavLinkProps & React.RefAttributes<HTMLAnchorElement>>;
-export interface FetcherFormProps extends React.FormHTMLAttributes<HTMLFormElement> {
+/**
+ * Form props shared by navigations and fetchers
+ */
+interface SharedFormProps extends React.FormHTMLAttributes<HTMLFormElement> {
     /**
      * The HTTP verb to use when the form is submit. Supports "get", "post",
      * "put", "delete", "patch".
@@ -152,7 +156,15 @@ export interface FetcherFormProps extends React.FormHTMLAttributes<HTMLFormEleme
      */
     onSubmit?: React.FormEventHandler<HTMLFormElement>;
 }
-export interface FormProps extends FetcherFormProps {
+/**
+ * Form props available to fetchers
+ */
+export interface FetcherFormProps extends SharedFormProps {
+}
+/**
+ * Form props available to navigations
+ */
+export interface FormProps extends SharedFormProps {
     /**
      * Indicate a specific fetcherKey to use when using navigate=false
      */
@@ -242,7 +254,7 @@ export interface SubmitFunction {
  * Submits a fetcher `<form>` to the server without reloading the page.
  */
 export interface FetcherSubmitFunction {
-    (target: SubmitTarget, options?: Omit<SubmitOptions, "replace" | "state">): void;
+    (target: SubmitTarget, options?: FetcherSubmitOptions): void;
 }
 /**
  * Returns a function that may be used to programmatically submit a form (or

package/dist/index.js

@@ -1,5 +1,5 @@
 /**
- * React Router DOM v6.23.1
+ * React Router DOM v6.24.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -239,6 +239,7 @@ function createBrowserRouter(routes, opts) {
     routes,
     mapRouteProperties: UNSAFE_mapRouteProperties,
     unstable_dataStrategy: opts == null ? void 0 : opts.unstable_dataStrategy,
+    unstable_patchRoutesOnMiss: opts == null ? void 0 : opts.unstable_patchRoutesOnMiss,
     window: opts == null ? void 0 : opts.window
   }).initialize();
 }
@@ -255,6 +256,7 @@ function createHashRouter(routes, opts) {
     routes,
     mapRouteProperties: UNSAFE_mapRouteProperties,
     unstable_dataStrategy: opts == null ? void 0 : opts.unstable_dataStrategy,
+    unstable_patchRoutesOnMiss: opts == null ? void 0 : opts.unstable_patchRoutesOnMiss,
     window: opts == null ? void 0 : opts.window
   }).initialize();
 }