react-router 7.7.1 → 7.8.0-pre.1

package/dist/development/{components-CjQijYga.d.mts → components-CuPfnyiZ.d.mts}

@@ -1,4 +1,4 @@
-import { R as Router$1, I as InitialEntry, T as To, a as RelativeRoutingType, N as NonIndexRouteObject, L as LazyRouteFunction, b as IndexRouteObject, c as Location, A as Action, d as Navigator, e as RouterInit, F as FutureConfig, H as HydrationState, D as DataStrategyFunction, P as PatchRoutesOnNavigationFunction, f as RouteObject, g as RouteMatch, h as Params, U as UIMatch } from './route-data-CqEmXQub.mjs';
+import { R as Router$1, I as InitialEntry, T as To, a as RelativeRoutingType, N as NonIndexRouteObject, L as LazyRouteFunction, b as IndexRouteObject, c as Location, A as Action, d as Navigator, e as RouterInit, F as FutureConfig, H as HydrationState, D as DataStrategyFunction, P as PatchRoutesOnNavigationFunction, f as RouteObject, g as RouteMatch, h as Params, U as UIMatch } from './context-DohQKLID.mjs';
 import * as React from 'react';
 
 declare function mapRouteProperties(route: RouteObject): Partial<RouteObject> & {
@@ -14,8 +14,11 @@ interface MemoryRouterOpts {
      */
     basename?: string;
     /**
-     * Function to provide the initial context values for all client side
-     * navigations/fetches
+     * A function that returns an {@link unstable_RouterContextProvider} instance
+     * which is provided as the `context` argument to client [`action`](../../start/data/route-object#action)s,
+     * [`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
+     * This function is called to generate a fresh `context` instance on each
+     * navigation or fetcher call.
      */
     unstable_getContext?: RouterInit["unstable_getContext"];
     /**
@@ -32,7 +35,7 @@ interface MemoryRouterOpts {
      */
     initialEntries?: InitialEntry[];
     /**
-     * Index of {@link initialEntries} the application should initialize to
+     * Index of `initialEntries` the application should initialize to
      */
     initialIndex?: number;
     /**
@@ -89,7 +92,7 @@ interface RouterProviderProps {
  * Render the UI for the given {@link DataRouter}. This component should
  * typically be at the top of an app's element tree.
  *
- * @example
+ * ```tsx
  * import { createBrowserRouter } from "react-router";
  * import { RouterProvider } from "react-router/dom";
  * import { createRoot } from "react-dom/client";
@@ -98,6 +101,14 @@ interface RouterProviderProps {
  * createRoot(document.getElementById("root")).render(
  *   <RouterProvider router={router} />
  * );
+ * ```
+ *
+ * <docs-info>Please note that this component is exported both from
+ * `react-router` and `react-router/dom` with the only difference being that the
+ * latter automatically wires up `react-dom`'s [`flushSync`](https://react.dev/reference/react-dom/flushSync)
+ * implementation. You _almost always_ want to use the version from
+ * `react-router/dom` unless you're running in a non-DOM environment.</docs-info>
+ *
  *
  * @public
  * @category Data Routers
@@ -125,7 +136,7 @@ interface MemoryRouterProps {
      */
     initialEntries?: InitialEntry[];
     /**
-     * Index of {@link initialEntries} the application should initialize to
+     * Index of `initialEntries` the application should initialize to
      */
     initialIndex?: number;
 }
@@ -140,7 +151,8 @@ interface MemoryRouterProps {
  * @param {MemoryRouterProps.children} props.children n/a
  * @param {MemoryRouterProps.initialEntries} props.initialEntries n/a
  * @param {MemoryRouterProps.initialIndex} props.initialIndex n/a
- * @returns A declarative in memory router for client side routing.
+ * @returns A declarative in-memory {@link Router | `<Router>`} for client-side
+ * routing.
  */
 declare function MemoryRouter({ basename, children, initialEntries, initialIndex, }: MemoryRouterProps): React.ReactElement;
 /**
@@ -161,7 +173,7 @@ interface NavigateProps {
      */
     state?: any;
     /**
-     * How to interpret relative routing in the {@link to} prop.
+     * How to interpret relative routing in the `to` prop.
      * See {@link RelativeRoutingType}.
      */
     relative?: RelativeRoutingType;
@@ -279,32 +291,32 @@ interface PathRouteProps {
     children?: React.ReactNode;
     /**
      * The React element to render when this Route matches.
-     * Mutually exclusive with {@link Component}.
+     * Mutually exclusive with `Component`.
      */
     element?: React.ReactNode | null;
     /**
      * The React element to render while this router is loading data.
-     * Mutually exclusive with {@link HydrateFallback}.
+     * Mutually exclusive with `HydrateFallback`.
      */
     hydrateFallbackElement?: React.ReactNode | null;
     /**
      * The React element to render at this route if an error occurs.
-     * Mutually exclusive with {@link ErrorBoundary}.
+     * Mutually exclusive with `ErrorBoundary`.
      */
     errorElement?: React.ReactNode | null;
     /**
      * The React Component to render when this route matches.
-     * Mutually exclusive with {@link element}.
+     * Mutually exclusive with `element`.
      */
     Component?: React.ComponentType | null;
     /**
      * The React Component to render while this router is loading data.
-     * Mutually exclusive with {@link hydrateFallbackElement}.
+     * Mutually exclusive with `hydrateFallbackElement`.
      */
     HydrateFallback?: React.ComponentType | null;
     /**
      * The React Component to render at this route if an error occurs.
-     * Mutually exclusive with {@link errorElement}.
+     * Mutually exclusive with `errorElement`.
      */
     ErrorBoundary?: React.ComponentType | null;
 }
@@ -366,32 +378,32 @@ interface IndexRouteProps {
     children?: undefined;
     /**
      * The React element to render when this Route matches.
-     * Mutually exclusive with {@link Component}.
+     * Mutually exclusive with `Component`.
      */
     element?: React.ReactNode | null;
     /**
      * The React element to render while this router is loading data.
-     * Mutually exclusive with {@link HydrateFallback}.
+     * Mutually exclusive with `HydrateFallback`.
      */
     hydrateFallbackElement?: React.ReactNode | null;
     /**
      * The React element to render at this route if an error occurs.
-     * Mutually exclusive with {@link ErrorBoundary}.
+     * Mutually exclusive with `ErrorBoundary`.
      */
     errorElement?: React.ReactNode | null;
     /**
      * The React Component to render when this route matches.
-     * Mutually exclusive with {@link element}.
+     * Mutually exclusive with `element`.
      */
     Component?: React.ComponentType | null;
     /**
      * The React Component to render while this router is loading data.
-     * Mutually exclusive with {@link hydrateFallbackElement}.
+     * Mutually exclusive with `hydrateFallbackElement`.
      */
     HydrateFallback?: React.ComponentType | null;
     /**
      * The React Component to render at this route if an error occurs.
-     * Mutually exclusive with {@link errorElement}.
+     * Mutually exclusive with `errorElement`.
      */
     ErrorBoundary?: React.ComponentType | null;
 }
@@ -471,7 +483,7 @@ interface RouterProps {
      */
     location: Partial<Location> | string;
     /**
-     * The type of navigation that triggered this location change.
+     * The type of navigation that triggered this `location` change.
      * Defaults to {@link NavigationType.Pop}.
      */
     navigationType?: Action;