react-router 0.0.0-experimental-a65d6f5 → 0.0.0-experimental-c19b79d

package/dist/development/{router-DQIRhYoj.d.mts → context-BqL5Eckq.d.mts}

@@ -394,11 +394,6 @@ type DefaultContext = MiddlewareEnabled extends true ? Readonly<RouterContextPro
 interface DataFunctionArgs<Context> {
     /** A {@link https://developer.mozilla.org/en-US/docs/Web/API/Request Fetch Request instance} which you can use to read headers (like cookies, and {@link https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams URLSearchParams} from the request. */
     request: Request;
-    /**
-     * Matched un-interpolated route pattern for the current path (i.e., /blog/:slug).
-     * Mostly useful as a identifier to aggregate on for logging/tracing/etc.
-     */
-    unstable_pattern: string;
     /**
      * {@link https://reactrouter.com/start/framework/routing#dynamic-segments Dynamic route params} for the current route.
      * @example
@@ -619,7 +614,7 @@ type AgnosticPatchRoutesOnNavigationFunction<O extends AgnosticRouteObject = Agn
  * properties from framework-agnostic properties
  */
 interface MapRoutePropertiesFunction {
-    (route: AgnosticDataRouteObject): {
+    (route: AgnosticRouteObject): {
         hasErrorBoundary: boolean;
     } & Record<string, any>;
 }
@@ -1044,1678 +1039,1530 @@ declare class ErrorResponseImpl implements ErrorResponse {
  */
 declare function isRouteErrorResponse(error: any): error is ErrorResponse;
 
-declare function mapRouteProperties(route: RouteObject): Partial<RouteObject> & {
-    hasErrorBoundary: boolean;
-};
-declare const hydrationRouteProperties: (keyof RouteObject)[];
 /**
- * @category Data Routers
+ * A Router instance manages all navigation and data loading/mutations
  */
-interface MemoryRouterOpts {
+interface Router$1 {
     /**
-     * Basename path for the application.
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Return the basename for the router
      */
-    basename?: string;
+    get basename(): RouterInit["basename"];
     /**
-     * A function that returns an {@link 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.
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Return the future config for the router
      */
-    getContext?: RouterInit["getContext"];
+    get future(): FutureConfig;
     /**
-     * Future flags to enable for the router.
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Return the current state of the router
      */
-    future?: Partial<FutureConfig>;
+    get state(): RouterState;
     /**
-     * Hydration data to initialize the router with if you have already performed
-     * data loading on the server.
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Return the routes for this router instance
      */
-    hydrationData?: HydrationState;
+    get routes(): AgnosticDataRouteObject[];
     /**
-     * Initial entries in the in-memory history stack
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Return the window associated with the router
      */
-    initialEntries?: InitialEntry[];
+    get window(): RouterInit["window"];
     /**
-     * Index of `initialEntries` the application should initialize to
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Initialize the router, including adding history listeners and kicking off
+     * initial data fetches.  Returns a function to cleanup listeners and abort
+     * any in-progress loads
      */
-    initialIndex?: number;
+    initialize(): Router$1;
     /**
-     * Array of instrumentation objects allowing you to instrument the router and
-     * individual routes prior to router initialization (and on any subsequently
-     * added routes via `route.lazy` or `patchRoutesOnNavigation`).  This is
-     * mostly useful for observability such as wrapping navigations, fetches,
-     * as well as route loaders/actions/middlewares with logging and/or performance
-     * tracing.
+     * @private
+     * PRIVATE - DO NOT USE
      *
-     * ```tsx
-     * let router = createBrowserRouter(routes, {
-     *   unstable_instrumentations: [logging]
-     * });
-     *
-     *
-     * let logging = {
-     *   router({ instrument }) {
-     *     instrument({
-     *       navigate: (impl, info) => logExecution(`navigate ${info.to}`, impl),
-     *       fetch: (impl, info) => logExecution(`fetch ${info.to}`, impl)
-     *     });
-     *   },
-     *   route({ instrument, id }) {
-     *     instrument({
-     *       middleware: (impl, info) => logExecution(
-     *         `middleware ${info.request.url} (route ${id})`,
-     *         impl
-     *       ),
-     *       loader: (impl, info) => logExecution(
-     *         `loader ${info.request.url} (route ${id})`,
-     *         impl
-     *       ),
-     *       action: (impl, info) => logExecution(
-     *         `action ${info.request.url} (route ${id})`,
-     *         impl
-     *       ),
-     *     })
-     *   }
-     * };
-     *
-     * async function logExecution(label: string, impl: () => Promise<void>) {
-     *   let start = performance.now();
-     *   console.log(`start ${label}`);
-     *   try {
-     *     await impl();
-     *   } finally {
-     *     let end = performance.now();
-     *     console.log(`end ${label} (${Math.round(end - start)}ms)`);
-     *   }
-     * }
-     * ```
+     * Subscribe to router.state updates
+     *
+     * @param fn function to call with the new state
      */
-    unstable_instrumentations?: unstable_ClientInstrumentation[];
+    subscribe(fn: RouterSubscriber): () => void;
     /**
-     * Override the default data strategy of loading in parallel.
-     * Only intended for advanced usage.
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Enable scroll restoration behavior in the router
+     *
+     * @param savedScrollPositions Object that will manage positions, in case
+     *                             it's being restored from sessionStorage
+     * @param getScrollPosition    Function to get the active Y scroll position
+     * @param getKey               Function to get the key to use for restoration
      */
-    dataStrategy?: DataStrategyFunction;
+    enableScrollRestoration(savedScrollPositions: Record<string, number>, getScrollPosition: GetScrollPositionFunction, getKey?: GetScrollRestorationKeyFunction): () => void;
     /**
-     * Lazily define portions of the route tree on navigations.
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Navigate forward/backward in the history stack
+     * @param to Delta to move in the history stack
      */
-    patchRoutesOnNavigation?: PatchRoutesOnNavigationFunction;
-}
-/**
- * Create a new {@link DataRouter} that manages the application path using an
- * in-memory [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
- * stack. Useful for non-browser environments without a DOM API.
- *
- * @public
- * @category Data Routers
- * @mode data
- * @param routes Application routes
- * @param opts Options
- * @param {MemoryRouterOpts.basename} opts.basename n/a
- * @param {MemoryRouterOpts.dataStrategy} opts.dataStrategy n/a
- * @param {MemoryRouterOpts.future} opts.future n/a
- * @param {MemoryRouterOpts.getContext} opts.getContext n/a
- * @param {MemoryRouterOpts.hydrationData} opts.hydrationData n/a
- * @param {MemoryRouterOpts.initialEntries} opts.initialEntries n/a
- * @param {MemoryRouterOpts.initialIndex} opts.initialIndex n/a
- * @param {MemoryRouterOpts.unstable_instrumentations} opts.unstable_instrumentations n/a
- * @param {MemoryRouterOpts.patchRoutesOnNavigation} opts.patchRoutesOnNavigation n/a
- * @returns An initialized {@link DataRouter} to pass to {@link RouterProvider | `<RouterProvider>`}
- */
-declare function createMemoryRouter(routes: RouteObject[], opts?: MemoryRouterOpts): Router;
-/**
- * Function signature for client side error handling for loader/actions errors
- * and rendering errors via `componentDidCatch`
- */
-interface unstable_ClientOnErrorFunction {
-    (error: unknown, errorInfo?: React.ErrorInfo): void;
-}
-/**
- * @category Types
- */
-interface RouterProviderProps {
+    navigate(to: number): Promise<void>;
     /**
-     * The {@link DataRouter} instance to use for navigation and data fetching.
+     * Navigate to the given path
+     * @param to Path to navigate to
+     * @param opts Navigation options (method, submission, etc.)
      */
-    router: Router;
+    navigate(to: To | null, opts?: RouterNavigateOptions): Promise<void>;
     /**
-     * The [`ReactDOM.flushSync`](https://react.dev/reference/react-dom/flushSync)
-     * implementation to use for flushing updates.
+     * @private
+     * PRIVATE - DO NOT USE
      *
-     * You usually don't have to worry about this:
-     * - The `RouterProvider` exported from `react-router/dom` handles this internally for you
-     * - If you are rendering in a non-DOM environment, you can import
-     *   `RouterProvider` from `react-router` and ignore this prop
+     * Trigger a fetcher load/submission
+     *
+     * @param key     Fetcher key
+     * @param routeId Route that owns the fetcher
+     * @param href    href to fetch
+     * @param opts    Fetcher options, (method, submission, etc.)
      */
-    flushSync?: (fn: () => unknown) => undefined;
+    fetch(key: string, routeId: string, href: string | null, opts?: RouterFetchOptions): Promise<void>;
     /**
-     * An error handler function that will be called for any loader/action/render
-     * errors that are encountered in your application.  This is useful for
-     * logging or reporting errors instead of the `ErrorBoundary` because it's not
-     * subject to re-rendering and will only run one time per error.
-     *
-     * The `errorInfo` parameter is passed along from
-     * [`componentDidCatch`](https://react.dev/reference/react/Component#componentdidcatch)
-     * and is only present for render errors.
+     * @private
+     * PRIVATE - DO NOT USE
      *
-     * ```tsx
-     * <RouterProvider unstable_onError=(error, errorInfo) => {
-     *   console.error(error, errorInfo);
-     *   reportToErrorService(error, errorInfo);
-     * }} />
-     * ```
+     * Trigger a revalidation of all current route loaders and fetcher loads
      */
-    unstable_onError?: unstable_ClientOnErrorFunction;
-}
-/**
- * Render the UI for the given {@link DataRouter}. This component should
- * typically be at the top of an app's element tree.
- *
- * ```tsx
- * import { createBrowserRouter } from "react-router";
- * import { RouterProvider } from "react-router/dom";
- * import { createRoot } from "react-dom/client";
- *
- * const router = createBrowserRouter(routes);
- * 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
- * @mode data
- * @param props Props
- * @param {RouterProviderProps.flushSync} props.flushSync n/a
- * @param {RouterProviderProps.unstable_onError} props.unstable_onError n/a
- * @param {RouterProviderProps.router} props.router n/a
- * @returns React element for the rendered router
- */
-declare function RouterProvider({ router, flushSync: reactDomFlushSyncImpl, unstable_onError, }: RouterProviderProps): React.ReactElement;
-/**
- * @category Types
- */
-interface MemoryRouterProps {
+    revalidate(): Promise<void>;
     /**
-     * Application basename
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Utility function to create an href for the given location
+     * @param location
      */
-    basename?: string;
+    createHref(location: Location | URL): string;
     /**
-     * Nested {@link Route} elements describing the route tree
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Utility function to URL encode a destination path according to the internal
+     * history implementation
+     * @param to
      */
-    children?: React.ReactNode;
+    encodeLocation(to: To): Path;
     /**
-     * Initial entries in the in-memory history stack
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Get/create a fetcher for the given key
+     * @param key
      */
-    initialEntries?: InitialEntry[];
+    getFetcher<TData = any>(key: string): Fetcher<TData>;
     /**
-     * Index of `initialEntries` the application should initialize to
+     * @internal
+     * PRIVATE - DO NOT USE
+     *
+     * Reset the fetcher for a given key
+     * @param key
      */
-    initialIndex?: number;
-}
-/**
- * A declarative {@link Router | `<Router>`} that stores all entries in memory.
- *
- * @public
- * @category Declarative Routers
- * @mode declarative
- * @param props Props
- * @param {MemoryRouterProps.basename} props.basename n/a
- * @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 {@link Router | `<Router>`} for client-side
- * routing.
- */
-declare function MemoryRouter({ basename, children, initialEntries, initialIndex, }: MemoryRouterProps): React.ReactElement;
-/**
- * @category Types
- */
-interface NavigateProps {
+    resetFetcher(key: string, opts?: {
+        reason?: unknown;
+    }): void;
     /**
-     * The path to navigate to. This can be a string or a {@link Path} object
-     */
-    to: To;
-    /**
-     * Whether to replace the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
-     * stack
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Delete the fetcher for a given key
+     * @param key
      */
-    replace?: boolean;
+    deleteFetcher(key: string): void;
     /**
-     * State to pass to the new {@link Location} to store in [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state).
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Cleanup listeners and abort any in-progress loads
      */
-    state?: any;
+    dispose(): void;
     /**
-     * How to interpret relative routing in the `to` prop.
-     * See {@link RelativeRoutingType}.
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Get a navigation blocker
+     * @param key The identifier for the blocker
+     * @param fn The blocker function implementation
      */
-    relative?: RelativeRoutingType;
-}
-/**
- * A component-based version of {@link useNavigate} to use in a
- * [`React.Component` class](https://react.dev/reference/react/Component) where
- * hooks cannot be used.
- *
- * It's recommended to avoid using this component in favor of {@link useNavigate}.
- *
- * @example
- * <Navigate to="/tasks" />
- *
- * @public
- * @category Components
- * @param props Props
- * @param {NavigateProps.relative} props.relative n/a
- * @param {NavigateProps.replace} props.replace n/a
- * @param {NavigateProps.state} props.state n/a
- * @param {NavigateProps.to} props.to n/a
- * @returns {void}
- *
- */
-declare function Navigate({ to, replace, state, relative, }: NavigateProps): null;
-/**
- * @category Types
- */
-interface OutletProps {
+    getBlocker(key: string, fn: BlockerFunction): Blocker;
     /**
-     * Provides a context value to the element tree below the outlet. Use when
-     * the parent route needs to provide values to child routes.
-     *
-     * ```tsx
-     * <Outlet context={myContextValue} />
-     * ```
+     * @private
+     * PRIVATE - DO NOT USE
      *
-     * Access the context with {@link useOutletContext}.
+     * Delete a navigation blocker
+     * @param key The identifier for the blocker
      */
-    context?: unknown;
-}
-/**
- * Renders the matching child route of a parent route or nothing if no child
- * route matches.
- *
- * @example
- * import { Outlet } from "react-router";
- *
- * export default function SomeParent() {
- *   return (
- *     <div>
- *       <h1>Parent Content</h1>
- *       <Outlet />
- *     </div>
- *   );
- * }
- *
- * @public
- * @category Components
- * @param props Props
- * @param {OutletProps.context} props.context n/a
- * @returns React element for the rendered outlet or `null` if no child route matches.
- */
-declare function Outlet(props: OutletProps): React.ReactElement | null;
-/**
- * @category Types
- */
-interface PathRouteProps {
+    deleteBlocker(key: string): void;
     /**
-     * Whether the path should be case-sensitive. Defaults to `false`.
+     * @private
+     * PRIVATE DO NOT USE
+     *
+     * Patch additional children routes into an existing parent route
+     * @param routeId The parent route id or a callback function accepting `patch`
+     *                to perform batch patching
+     * @param children The additional children routes
+     * @param unstable_allowElementMutations Allow mutation or route elements on
+     *                                       existing routes. Intended for RSC-usage
+     *                                       only.
      */
-    caseSensitive?: NonIndexRouteObject["caseSensitive"];
+    patchRoutes(routeId: string | null, children: AgnosticRouteObject[], unstable_allowElementMutations?: boolean): void;
     /**
-     * The path pattern to match. If unspecified or empty, then this becomes a
-     * layout route.
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * HMR needs to pass in-flight route updates to React Router
+     * TODO: Replace this with granular route update APIs (addRoute, updateRoute, deleteRoute)
      */
-    path?: NonIndexRouteObject["path"];
+    _internalSetRoutes(routes: AgnosticRouteObject[]): void;
     /**
-     * The unique identifier for this route (for use with {@link DataRouter}s)
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Cause subscribers to re-render.  This is used to force a re-render.
      */
-    id?: NonIndexRouteObject["id"];
+    _internalSetStateDoNotUseOrYouWillBreakYourApp(state: Partial<RouterState>): void;
     /**
-     * A function that returns a promise that resolves to the route object.
-     * Used for code-splitting routes.
-     * See [`lazy`](../../start/data/route-object#lazy).
+     * @private
+     * PRIVATE - DO NOT USE
+     *
+     * Internal fetch AbortControllers accessed by unit tests
      */
-    lazy?: LazyRouteFunction<NonIndexRouteObject>;
+    _internalFetchControllers: Map<string, AbortController>;
+}
+/**
+ * State maintained internally by the router.  During a navigation, all states
+ * reflect the "old" location unless otherwise noted.
+ */
+interface RouterState {
     /**
-     * The route middleware.
-     * See [`middleware`](../../start/data/route-object#middleware).
+     * The action of the most recent navigation
      */
-    middleware?: NonIndexRouteObject["middleware"];
+    historyAction: Action;
     /**
-     * The route loader.
-     * See [`loader`](../../start/data/route-object#loader).
+     * The current location reflected by the router
      */
-    loader?: NonIndexRouteObject["loader"];
+    location: Location;
     /**
-     * The route action.
-     * See [`action`](../../start/data/route-object#action).
+     * The current set of route matches
      */
-    action?: NonIndexRouteObject["action"];
-    hasErrorBoundary?: NonIndexRouteObject["hasErrorBoundary"];
+    matches: AgnosticDataRouteMatch[];
     /**
-     * The route shouldRevalidate function.
-     * See [`shouldRevalidate`](../../start/data/route-object#shouldRevalidate).
+     * Tracks whether we've completed our initial data load
      */
-    shouldRevalidate?: NonIndexRouteObject["shouldRevalidate"];
+    initialized: boolean;
     /**
-     * The route handle.
+     * Current scroll position we should start at for a new view
+     *  - number -> scroll position to restore to
+     *  - false -> do not restore scroll at all (used during submissions/revalidations)
+     *  - null -> don't have a saved position, scroll to hash or top of page
      */
-    handle?: NonIndexRouteObject["handle"];
+    restoreScrollPosition: number | false | null;
     /**
-     * Whether this is an index route.
+     * Indicate whether this navigation should skip resetting the scroll position
+     * if we are unable to restore the scroll position
      */
-    index?: false;
+    preventScrollReset: boolean;
     /**
-     * Child Route components
+     * Tracks the state of the current navigation
      */
-    children?: React.ReactNode;
+    navigation: Navigation;
     /**
-     * The React element to render when this Route matches.
-     * Mutually exclusive with `Component`.
+     * Tracks any in-progress revalidations
      */
-    element?: React.ReactNode | null;
+    revalidation: RevalidationState;
     /**
-     * The React element to render while this router is loading data.
-     * Mutually exclusive with `HydrateFallback`.
+     * Data from the loaders for the current matches
      */
-    hydrateFallbackElement?: React.ReactNode | null;
+    loaderData: RouteData;
     /**
-     * The React element to render at this route if an error occurs.
-     * Mutually exclusive with `ErrorBoundary`.
+     * Data from the action for the current matches
      */
-    errorElement?: React.ReactNode | null;
+    actionData: RouteData | null;
     /**
-     * The React Component to render when this route matches.
-     * Mutually exclusive with `element`.
+     * Errors caught from loaders for the current matches
      */
-    Component?: React.ComponentType | null;
+    errors: RouteData | null;
     /**
-     * The React Component to render while this router is loading data.
-     * Mutually exclusive with `hydrateFallbackElement`.
+     * Map of current fetchers
      */
-    HydrateFallback?: React.ComponentType | null;
+    fetchers: Map<string, Fetcher>;
     /**
-     * The React Component to render at this route if an error occurs.
-     * Mutually exclusive with `errorElement`.
+     * Map of current blockers
      */
-    ErrorBoundary?: React.ComponentType | null;
+    blockers: Map<string, Blocker>;
 }
 /**
- * @category Types
+ * Data that can be passed into hydrate a Router from SSR
  */
-interface LayoutRouteProps extends PathRouteProps {
+type HydrationState = Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>;
+/**
+ * Future flags to toggle new feature behavior
+ */
+interface FutureConfig {
 }
 /**
- * @category Types
+ * Initialization options for createRouter
  */
-interface IndexRouteProps {
-    /**
-     * Whether the path should be case-sensitive. Defaults to `false`.
-     */
-    caseSensitive?: IndexRouteObject["caseSensitive"];
-    /**
-     * The path pattern to match. If unspecified or empty, then this becomes a
-     * layout route.
-     */
-    path?: IndexRouteObject["path"];
-    /**
-     * The unique identifier for this route (for use with {@link DataRouter}s)
-     */
-    id?: IndexRouteObject["id"];
-    /**
-     * A function that returns a promise that resolves to the route object.
-     * Used for code-splitting routes.
-     * See [`lazy`](../../start/data/route-object#lazy).
-     */
-    lazy?: LazyRouteFunction<IndexRouteObject>;
-    /**
-     * The route middleware.
-     * See [`middleware`](../../start/data/route-object#middleware).
-     */
-    middleware?: IndexRouteObject["middleware"];
-    /**
-     * The route loader.
-     * See [`loader`](../../start/data/route-object#loader).
-     */
-    loader?: IndexRouteObject["loader"];
-    /**
-     * The route action.
-     * See [`action`](../../start/data/route-object#action).
-     */
-    action?: IndexRouteObject["action"];
-    hasErrorBoundary?: IndexRouteObject["hasErrorBoundary"];
-    /**
-     * The route shouldRevalidate function.
-     * See [`shouldRevalidate`](../../start/data/route-object#shouldRevalidate).
-     */
-    shouldRevalidate?: IndexRouteObject["shouldRevalidate"];
-    /**
-     * The route handle.
-     */
-    handle?: IndexRouteObject["handle"];
-    /**
-     * Whether this is an index route.
-     */
-    index: true;
-    /**
-     * Child Route components
-     */
-    children?: undefined;
-    /**
-     * The React element to render when this Route matches.
-     * Mutually exclusive with `Component`.
-     */
-    element?: React.ReactNode | null;
-    /**
-     * The React element to render while this router is loading data.
-     * Mutually exclusive with `HydrateFallback`.
-     */
-    hydrateFallbackElement?: React.ReactNode | null;
-    /**
-     * The React element to render at this route if an error occurs.
-     * Mutually exclusive with `ErrorBoundary`.
-     */
-    errorElement?: React.ReactNode | null;
-    /**
-     * The React Component to render when this route matches.
-     * Mutually exclusive with `element`.
-     */
-    Component?: React.ComponentType | null;
-    /**
-     * The React Component to render while this router is loading data.
-     * Mutually exclusive with `hydrateFallbackElement`.
-     */
-    HydrateFallback?: React.ComponentType | null;
-    /**
-     * The React Component to render at this route if an error occurs.
-     * Mutually exclusive with `errorElement`.
-     */
-    ErrorBoundary?: React.ComponentType | null;
+interface RouterInit {
+    routes: AgnosticRouteObject[];
+    history: History;
+    basename?: string;
+    getContext?: () => MaybePromise<RouterContextProvider>;
+    mapRouteProperties?: MapRoutePropertiesFunction;
+    future?: Partial<FutureConfig>;
+    hydrationRouteProperties?: string[];
+    hydrationData?: HydrationState;
+    window?: Window;
+    dataStrategy?: DataStrategyFunction;
+    patchRoutesOnNavigation?: AgnosticPatchRoutesOnNavigationFunction;
 }
-type RouteProps = PathRouteProps | LayoutRouteProps | IndexRouteProps;
 /**
- * Configures an element to render when a pattern matches the current location.
- * It must be rendered within a {@link Routes} element. Note that these routes
- * do not participate in data loading, actions, code splitting, or any other
- * route module features.
- *
- * @example
- * // Usually used in a declarative router
- * function App() {
- *   return (
- *     <BrowserRouter>
- *       <Routes>
- *         <Route index element={<StepOne />} />
- *         <Route path="step-2" element={<StepTwo />} />
- *         <Route path="step-3" element={<StepThree />} />
- *       </Routes>
- *    </BrowserRouter>
- *   );
- * }
- *
- * // But can be used with a data router as well if you prefer the JSX notation
- * const routes = createRoutesFromElements(
- *   <>
- *     <Route index loader={step1Loader} Component={StepOne} />
- *     <Route path="step-2" loader={step2Loader} Component={StepTwo} />
- *     <Route path="step-3" loader={step3Loader} Component={StepThree} />
- *   </>
- * );
- *
- * const router = createBrowserRouter(routes);
- *
- * function App() {
- *   return <RouterProvider router={router} />;
- * }
- *
- * @public
- * @category Components
- * @param props Props
- * @param {PathRouteProps.action} props.action n/a
- * @param {PathRouteProps.caseSensitive} props.caseSensitive n/a
- * @param {PathRouteProps.Component} props.Component n/a
- * @param {PathRouteProps.children} props.children n/a
- * @param {PathRouteProps.element} props.element n/a
- * @param {PathRouteProps.ErrorBoundary} props.ErrorBoundary n/a
- * @param {PathRouteProps.errorElement} props.errorElement n/a
- * @param {PathRouteProps.handle} props.handle n/a
- * @param {PathRouteProps.HydrateFallback} props.HydrateFallback n/a
- * @param {PathRouteProps.hydrateFallbackElement} props.hydrateFallbackElement n/a
- * @param {PathRouteProps.id} props.id n/a
- * @param {PathRouteProps.index} props.index n/a
- * @param {PathRouteProps.lazy} props.lazy n/a
- * @param {PathRouteProps.loader} props.loader n/a
- * @param {PathRouteProps.path} props.path n/a
- * @param {PathRouteProps.shouldRevalidate} props.shouldRevalidate n/a
- * @returns {void}
+ * State returned from a server-side query() call
  */
-declare function Route(props: RouteProps): React.ReactElement | null;
+interface StaticHandlerContext {
+    basename: Router$1["basename"];
+    location: RouterState["location"];
+    matches: RouterState["matches"];
+    loaderData: RouterState["loaderData"];
+    actionData: RouterState["actionData"];
+    errors: RouterState["errors"];
+    statusCode: number;
+    loaderHeaders: Record<string, Headers>;
+    actionHeaders: Record<string, Headers>;
+    _deepestRenderedBoundaryId?: string | null;
+}
 /**
- * @category Types
+ * A StaticHandler instance manages a singular SSR navigation/fetch event
  */
-interface RouterProps {
-    /**
-     * The base path for the application. This is prepended to all locations
-     */
-    basename?: string;
-    /**
-     * Nested {@link Route} elements describing the route tree
-     */
-    children?: React.ReactNode;
-    /**
-     * The location to match against. Defaults to the current location.
-     * This can be a string or a {@link Location} object.
-     */
-    location: Partial<Location> | string;
-    /**
-     * The type of navigation that triggered this `location` change.
-     * Defaults to {@link NavigationType.Pop}.
-     */
-    navigationType?: Action;
-    /**
-     * The navigator to use for navigation. This is usually a history object
-     * or a custom navigator that implements the {@link Navigator} interface.
-     */
-    navigator: Navigator;
-    /**
-     * Whether this router is static or not (used for SSR). If `true`, the router
-     * will not be reactive to location changes.
-     */
-    static?: boolean;
+interface StaticHandler {
+    dataRoutes: AgnosticDataRouteObject[];
+    query(request: Request, opts?: {
+        requestContext?: unknown;
+        filterMatchesToLoad?: (match: AgnosticDataRouteMatch) => boolean;
+        skipLoaderErrorBubbling?: boolean;
+        skipRevalidation?: boolean;
+        dataStrategy?: DataStrategyFunction<unknown>;
+        generateMiddlewareResponse?: (query: (r: Request, args?: {
+            filterMatchesToLoad?: (match: AgnosticDataRouteMatch) => boolean;
+        }) => Promise<StaticHandlerContext | Response>) => MaybePromise<Response>;
+    }): Promise<StaticHandlerContext | Response>;
+    queryRoute(request: Request, opts?: {
+        routeId?: string;
+        requestContext?: unknown;
+        dataStrategy?: DataStrategyFunction<unknown>;
+        generateMiddlewareResponse?: (queryRoute: (r: Request) => Promise<Response>) => MaybePromise<Response>;
+    }): Promise<any>;
 }
+type ViewTransitionOpts = {
+    currentLocation: Location;
+    nextLocation: Location;
+};
 /**
- * Provides location context for the rest of the app.
- *
- * Note: You usually won't render a `<Router>` directly. Instead, you'll render a
- * router that is more specific to your environment such as a {@link BrowserRouter}
- * in web browsers or a {@link ServerRouter} for server rendering.
- *
- * @public
- * @category Declarative Routers
- * @mode declarative
- * @param props Props
- * @param {RouterProps.basename} props.basename n/a
- * @param {RouterProps.children} props.children n/a
- * @param {RouterProps.location} props.location n/a
- * @param {RouterProps.navigationType} props.navigationType n/a
- * @param {RouterProps.navigator} props.navigator n/a
- * @param {RouterProps.static} props.static n/a
- * @returns React element for the rendered router or `null` if the location does
- * not match the {@link props.basename}
+ * Subscriber function signature for changes to router state
  */
-declare function Router$1({ basename: basenameProp, children, location: locationProp, navigationType, navigator, static: staticProp, }: RouterProps): React.ReactElement | null;
+interface RouterSubscriber {
+    (state: RouterState, opts: {
+        deletedFetchers: string[];
+        viewTransitionOpts?: ViewTransitionOpts;
+        flushSync: boolean;
+    }): void;
+}
 /**
- * @category Types
+ * Function signature for determining the key to be used in scroll restoration
+ * for a given location
  */
-interface RoutesProps {
-    /**
-     * Nested {@link Route} elements
-     */
-    children?: React.ReactNode;
-    /**
-     * The {@link Location} to match against. Defaults to the current location.
-     */
-    location?: Partial<Location> | string;
+interface GetScrollRestorationKeyFunction {
+    (location: Location, matches: UIMatch[]): string | null;
 }
 /**
- * Renders a branch of {@link Route | `<Route>`s} that best matches the current
- * location. Note that these routes do not participate in [data loading](../../start/framework/route-module#loader),
- * [`action`](../../start/framework/route-module#action), code splitting, or
- * any other [route module](../../start/framework/route-module) features.
- *
- * @example
- * import { Route, Routes } from "react-router";
- *
- * <Routes>
- *   <Route index element={<StepOne />} />
- *   <Route path="step-2" element={<StepTwo />} />
- *   <Route path="step-3" element={<StepThree />}>
- * </Routes>
- *
- * @public
- * @category Components
- * @param props Props
- * @param {RoutesProps.children} props.children n/a
- * @param {RoutesProps.location} props.location n/a
- * @returns React element for the rendered routes or `null` if no route matches
+ * Function signature for determining the current scroll position
  */
-declare function Routes({ children, location, }: RoutesProps): React.ReactElement | null;
-interface AwaitResolveRenderFunction<Resolve = any> {
-    (data: Awaited<Resolve>): React.ReactNode;
+interface GetScrollPositionFunction {
+    (): number;
 }
 /**
- * @category Types
+ * - "route": relative to the route hierarchy so `..` means remove all segments
+ * of the current route even if it has many. For example, a `route("posts/:id")`
+ * would have both `:id` and `posts` removed from the url.
+ * - "path": relative to the pathname so `..` means remove one segment of the
+ * pathname. For example, a `route("posts/:id")` would have only `:id` removed
+ * from the url.
  */
-interface AwaitProps<Resolve> {
-    /**
-     * When using a function, the resolved value is provided as the parameter.
-     *
-     * ```tsx [2]
-     * <Await resolve={reviewsPromise}>
-     *   {(resolvedReviews) => <Reviews items={resolvedReviews} />}
-     * </Await>
-     * ```
-     *
-     * When using React elements, {@link useAsyncValue} will provide the
-     * resolved value:
-     *
-     * ```tsx [2]
-     * <Await resolve={reviewsPromise}>
-     *   <Reviews />
-     * </Await>
-     *
-     * function Reviews() {
-     *   const resolvedReviews = useAsyncValue();
-     *   return <div>...</div>;
-     * }
-     * ```
-     */
-    children: React.ReactNode | AwaitResolveRenderFunction<Resolve>;
+type RelativeRoutingType = "route" | "path";
+type BaseNavigateOrFetchOptions = {
+    preventScrollReset?: boolean;
+    relative?: RelativeRoutingType;
+    flushSync?: boolean;
+};
+type BaseNavigateOptions = BaseNavigateOrFetchOptions & {
+    replace?: boolean;
+    state?: any;
+    fromRouteId?: string;
+    viewTransition?: boolean;
+};
+type BaseSubmissionOptions = {
+    formMethod?: HTMLFormMethod;
+    formEncType?: FormEncType;
+} & ({
+    formData: FormData;
+    body?: undefined;
+} | {
+    formData?: undefined;
+    body: any;
+});
+/**
+ * Options for a navigate() call for a normal (non-submission) navigation
+ */
+type LinkNavigateOptions = BaseNavigateOptions;
+/**
+ * Options for a navigate() call for a submission navigation
+ */
+type SubmissionNavigateOptions = BaseNavigateOptions & BaseSubmissionOptions;
+/**
+ * Options to pass to navigate() for a navigation
+ */
+type RouterNavigateOptions = LinkNavigateOptions | SubmissionNavigateOptions;
+/**
+ * Options for a fetch() load
+ */
+type LoadFetchOptions = BaseNavigateOrFetchOptions;
+/**
+ * Options for a fetch() submission
+ */
+type SubmitFetchOptions = BaseNavigateOrFetchOptions & BaseSubmissionOptions;
+/**
+ * Options to pass to fetch()
+ */
+type RouterFetchOptions = LoadFetchOptions | SubmitFetchOptions;
+/**
+ * Potential states for state.navigation
+ */
+type NavigationStates = {
+    Idle: {
+        state: "idle";
+        location: undefined;
+        formMethod: undefined;
+        formAction: undefined;
+        formEncType: undefined;
+        formData: undefined;
+        json: undefined;
+        text: undefined;
+    };
+    Loading: {
+        state: "loading";
+        location: Location;
+        formMethod: Submission["formMethod"] | undefined;
+        formAction: Submission["formAction"] | undefined;
+        formEncType: Submission["formEncType"] | undefined;
+        formData: Submission["formData"] | undefined;
+        json: Submission["json"] | undefined;
+        text: Submission["text"] | undefined;
+    };
+    Submitting: {
+        state: "submitting";
+        location: Location;
+        formMethod: Submission["formMethod"];
+        formAction: Submission["formAction"];
+        formEncType: Submission["formEncType"];
+        formData: Submission["formData"];
+        json: Submission["json"];
+        text: Submission["text"];
+    };
+};
+type Navigation = NavigationStates[keyof NavigationStates];
+type RevalidationState = "idle" | "loading";
+/**
+ * Potential states for fetchers
+ */
+type FetcherStates<TData = any> = {
     /**
-     * The error element renders instead of the `children` when the [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
-     * rejects.
-     *
-     * ```tsx
-     * <Await
-     *   errorElement={<div>Oops</div>}
-     *   resolve={reviewsPromise}
-     * >
-     *   <Reviews />
-     * </Await>
-     * ```
-     *
-     * To provide a more contextual error, you can use the {@link useAsyncError} in a
-     * child component
+     * The fetcher is not calling a loader or action
      *
      * ```tsx
-     * <Await
-     *   errorElement={<ReviewsError />}
-     *   resolve={reviewsPromise}
-     * >
-     *   <Reviews />
-     * </Await>
-     *
-     * function ReviewsError() {
-     *   const error = useAsyncError();
-     *   return <div>Error loading reviews: {error.message}</div>;
-     * }
+     * fetcher.state === "idle"
      * ```
-     *
-     * If you do not provide an `errorElement`, the rejected value will bubble up
-     * to the nearest route-level [`ErrorBoundary`](../../start/framework/route-module#errorboundary)
-     * and be accessible via the {@link useRouteError} hook.
      */
-    errorElement?: React.ReactNode;
+    Idle: {
+        state: "idle";
+        formMethod: undefined;
+        formAction: undefined;
+        formEncType: undefined;
+        text: undefined;
+        formData: undefined;
+        json: undefined;
+        /**
+         * If the fetcher has never been called, this will be undefined.
+         */
+        data: TData | undefined;
+    };
     /**
-     * Takes a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
-     * returned from a [`loader`](../../start/framework/route-module#loader) to be
-     * resolved and rendered.
+     * The fetcher is loading data from a {@link LoaderFunction | loader} from a
+     * call to {@link FetcherWithComponents.load | `fetcher.load`}.
      *
      * ```tsx
-     * import { Await, useLoaderData } from "react-router";
-     *
-     * export async function loader() {
-     *   let reviews = getReviews(); // not awaited
-     *   let book = await getBook();
-     *   return {
-     *     book,
-     *     reviews, // this is a promise
-     *   };
-     * }
-     *
-     * export default function Book() {
-     *   const {
-     *     book,
-     *     reviews, // this is the same promise
-     *   } = useLoaderData();
+     * // somewhere
+     * <button onClick={() => fetcher.load("/some/route") }>Load</button>
      *
-     *   return (
-     *     <div>
-     *       <h1>{book.title}</h1>
-     *       <p>{book.description}</p>
-     *       <React.Suspense fallback={<ReviewsSkeleton />}>
-     *         <Await
-     *           // and is the promise we pass to Await
-     *           resolve={reviews}
-     *         >
-     *           <Reviews />
-     *         </Await>
-     *       </React.Suspense>
-     *     </div>
-     *   );
-     * }
+     * // the state will update
+     * fetcher.state === "loading"
      * ```
      */
-    resolve: Resolve;
+    Loading: {
+        state: "loading";
+        formMethod: Submission["formMethod"] | undefined;
+        formAction: Submission["formAction"] | undefined;
+        formEncType: Submission["formEncType"] | undefined;
+        text: Submission["text"] | undefined;
+        formData: Submission["formData"] | undefined;
+        json: Submission["json"] | undefined;
+        data: TData | undefined;
+    };
+    /**
+      The fetcher is submitting to a {@link LoaderFunction} (GET) or {@link ActionFunction} (POST) from a {@link FetcherWithComponents.Form | `fetcher.Form`} or {@link FetcherWithComponents.submit | `fetcher.submit`}.
+  
+      ```tsx
+      // somewhere
+      <input
+        onChange={e => {
+          fetcher.submit(event.currentTarget.form, { method: "post" });
+        }}
+      />
+  
+      // the state will update
+      fetcher.state === "submitting"
+  
+      // and formData will be available
+      fetcher.formData
+      ```
+     */
+    Submitting: {
+        state: "submitting";
+        formMethod: Submission["formMethod"];
+        formAction: Submission["formAction"];
+        formEncType: Submission["formEncType"];
+        text: Submission["text"];
+        formData: Submission["formData"];
+        json: Submission["json"];
+        data: TData | undefined;
+    };
+};
+type Fetcher<TData = any> = FetcherStates<TData>[keyof FetcherStates<TData>];
+interface BlockerBlocked {
+    state: "blocked";
+    reset: () => void;
+    proceed: () => void;
+    location: Location;
+}
+interface BlockerUnblocked {
+    state: "unblocked";
+    reset: undefined;
+    proceed: undefined;
+    location: undefined;
+}
+interface BlockerProceeding {
+    state: "proceeding";
+    reset: undefined;
+    proceed: undefined;
+    location: Location;
 }
+type Blocker = BlockerUnblocked | BlockerBlocked | BlockerProceeding;
+type BlockerFunction = (args: {
+    currentLocation: Location;
+    nextLocation: Location;
+    historyAction: Action;
+}) => boolean;
+declare const IDLE_NAVIGATION: NavigationStates["Idle"];
+declare const IDLE_FETCHER: FetcherStates["Idle"];
+declare const IDLE_BLOCKER: BlockerUnblocked;
 /**
- * Used to render promise values with automatic error handling.
- *
- * **Note:** `<Await>` expects to be rendered inside a [`<React.Suspense>`](https://react.dev/reference/react/Suspense)
- *
- * @example
- * import { Await, useLoaderData } from "react-router";
- *
- * export async function loader() {
- *   // not awaited
- *   const reviews = getReviews();
- *   // awaited (blocks the transition)
- *   const book = await fetch("/api/book").then((res) => res.json());
- *   return { book, reviews };
- * }
- *
- * function Book() {
- *   const { book, reviews } = useLoaderData();
- *   return (
- *     <div>
- *       <h1>{book.title}</h1>
- *       <p>{book.description}</p>
- *       <React.Suspense fallback={<ReviewsSkeleton />}>
- *         <Await
- *           resolve={reviews}
- *           errorElement={
- *             <div>Could not load reviews 😬</div>
- *           }
- *           children={(resolvedReviews) => (
- *             <Reviews items={resolvedReviews} />
- *           )}
- *         />
- *       </React.Suspense>
- *     </div>
- *   );
- * }
+ * Create a router and listen to history POP navigations
+ */
+declare function createRouter(init: RouterInit): Router$1;
+interface CreateStaticHandlerOptions {
+    basename?: string;
+    mapRouteProperties?: MapRoutePropertiesFunction;
+    future?: {};
+}
+
+declare function mapRouteProperties(route: RouteObject): Partial<RouteObject> & {
+    hasErrorBoundary: boolean;
+};
+declare const hydrationRouteProperties: (keyof RouteObject)[];
+/**
+ * @category Data Routers
+ */
+interface MemoryRouterOpts {
+    /**
+     * Basename path for the application.
+     */
+    basename?: string;
+    /**
+     * A function that returns an {@link 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.
+     */
+    getContext?: RouterInit["getContext"];
+    /**
+     * Future flags to enable for the router.
+     */
+    future?: Partial<FutureConfig>;
+    /**
+     * Hydration data to initialize the router with if you have already performed
+     * data loading on the server.
+     */
+    hydrationData?: HydrationState;
+    /**
+     * Initial entries in the in-memory history stack
+     */
+    initialEntries?: InitialEntry[];
+    /**
+     * Index of `initialEntries` the application should initialize to
+     */
+    initialIndex?: number;
+    /**
+     * Override the default data strategy of loading in parallel.
+     * Only intended for advanced usage.
+     */
+    dataStrategy?: DataStrategyFunction;
+    /**
+     * Lazily define portions of the route tree on navigations.
+     */
+    patchRoutesOnNavigation?: PatchRoutesOnNavigationFunction;
+}
+/**
+ * Create a new {@link DataRouter} that manages the application path using an
+ * in-memory [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
+ * stack. Useful for non-browser environments without a DOM API.
  *
  * @public
- * @category Components
- * @mode framework
+ * @category Data Routers
  * @mode data
- * @param props Props
- * @param {AwaitProps.children} props.children n/a
- * @param {AwaitProps.errorElement} props.errorElement n/a
- * @param {AwaitProps.resolve} props.resolve n/a
- * @returns React element for the rendered awaited value
+ * @param routes Application routes
+ * @param opts Options
+ * @param {MemoryRouterOpts.basename} opts.basename n/a
+ * @param {MemoryRouterOpts.dataStrategy} opts.dataStrategy n/a
+ * @param {MemoryRouterOpts.future} opts.future n/a
+ * @param {MemoryRouterOpts.getContext} opts.getContext n/a
+ * @param {MemoryRouterOpts.hydrationData} opts.hydrationData n/a
+ * @param {MemoryRouterOpts.initialEntries} opts.initialEntries n/a
+ * @param {MemoryRouterOpts.initialIndex} opts.initialIndex n/a
+ * @param {MemoryRouterOpts.patchRoutesOnNavigation} opts.patchRoutesOnNavigation n/a
+ * @returns An initialized {@link DataRouter} to pass to {@link RouterProvider | `<RouterProvider>`}
  */
-declare function Await<Resolve>({ children, errorElement, resolve, }: AwaitProps<Resolve>): React.JSX.Element;
+declare function createMemoryRouter(routes: RouteObject[], opts?: MemoryRouterOpts): Router$1;
 /**
- * Creates a route config from a React "children" object, which is usually
- * either a `<Route>` element or an array of them. Used internally by
- * `<Routes>` to create a route config from its children.
- *
- * @category Utils
- * @mode data
- * @param children The React children to convert into a route config
- * @param parentPath The path of the parent route, used to generate unique IDs.
- * @returns An array of {@link RouteObject}s that can be used with a {@link DataRouter}
+ * Function signature for client side error handling for loader/actions errors
+ * and rendering errors via `componentDidCatch`
  */
-declare function createRoutesFromChildren(children: React.ReactNode, parentPath?: number[]): RouteObject[];
+interface unstable_ClientOnErrorFunction {
+    (error: unknown, errorInfo?: React.ErrorInfo): void;
+}
 /**
- * Create route objects from JSX elements instead of arrays of objects.
+ * @category Types
+ */
+interface RouterProviderProps {
+    /**
+     * The {@link DataRouter} instance to use for navigation and data fetching.
+     */
+    router: Router$1;
+    /**
+     * The [`ReactDOM.flushSync`](https://react.dev/reference/react-dom/flushSync)
+     * implementation to use for flushing updates.
+     *
+     * You usually don't have to worry about this:
+     * - The `RouterProvider` exported from `react-router/dom` handles this internally for you
+     * - If you are rendering in a non-DOM environment, you can import
+     *   `RouterProvider` from `react-router` and ignore this prop
+     */
+    flushSync?: (fn: () => unknown) => undefined;
+    /**
+     * An error handler function that will be called for any loader/action/render
+     * errors that are encountered in your application.  This is useful for
+     * logging or reporting errors instead of the `ErrorBoundary` because it's not
+     * subject to re-rendering and will only run one time per error.
+     *
+     * The `errorInfo` parameter is passed along from
+     * [`componentDidCatch`](https://react.dev/reference/react/Component#componentdidcatch)
+     * and is only present for render errors.
+     *
+     * ```tsx
+     * <RouterProvider unstable_onError=(error, errorInfo) => {
+     *   console.error(error, errorInfo);
+     *   reportToErrorService(error, errorInfo);
+     * }} />
+     * ```
+     */
+    unstable_onError?: unstable_ClientOnErrorFunction;
+}
+/**
+ * Render the UI for the given {@link DataRouter}. This component should
+ * typically be at the top of an app's element tree.
  *
- * @example
- * const routes = createRoutesFromElements(
- *   <>
- *     <Route index loader={step1Loader} Component={StepOne} />
- *     <Route path="step-2" loader={step2Loader} Component={StepTwo} />
- *     <Route path="step-3" loader={step3Loader} Component={StepThree} />
- *   </>
- * );
+ * ```tsx
+ * import { createBrowserRouter } from "react-router";
+ * import { RouterProvider } from "react-router/dom";
+ * import { createRoot } from "react-dom/client";
  *
  * const router = createBrowserRouter(routes);
+ * 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>
  *
- * function App() {
- *   return <RouterProvider router={router} />;
- * }
  *
- * @name createRoutesFromElements
  * @public
- * @category Utils
+ * @category Data Routers
  * @mode data
- * @param children The React children to convert into a route config
- * @param parentPath The path of the parent route, used to generate unique IDs.
- * This is used for internal recursion and is not intended to be used by the
- * application developer.
- * @returns An array of {@link RouteObject}s that can be used with a {@link DataRouter}
+ * @param props Props
+ * @param {RouterProviderProps.flushSync} props.flushSync n/a
+ * @param {RouterProviderProps.unstable_onError} props.unstable_onError n/a
+ * @param {RouterProviderProps.router} props.router n/a
+ * @returns React element for the rendered router
  */
-declare const createRoutesFromElements: typeof createRoutesFromChildren;
+declare function RouterProvider({ router, flushSync: reactDomFlushSyncImpl, unstable_onError, }: RouterProviderProps): React.ReactElement;
 /**
- * Renders the result of {@link matchRoutes} into a React element.
+ * @category Types
+ */
+interface MemoryRouterProps {
+    /**
+     * Application basename
+     */
+    basename?: string;
+    /**
+     * Nested {@link Route} elements describing the route tree
+     */
+    children?: React.ReactNode;
+    /**
+     * Initial entries in the in-memory history stack
+     */
+    initialEntries?: InitialEntry[];
+    /**
+     * Index of `initialEntries` the application should initialize to
+     */
+    initialIndex?: number;
+}
+/**
+ * A declarative {@link Router | `<Router>`} that stores all entries in memory.
  *
  * @public
- * @category Utils
- * @param matches The array of {@link RouteMatch | route matches} to render
- * @returns A React element that renders the matched routes or `null` if no matches
+ * @category Declarative Routers
+ * @mode declarative
+ * @param props Props
+ * @param {MemoryRouterProps.basename} props.basename n/a
+ * @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 {@link Router | `<Router>`} for client-side
+ * routing.
  */
-declare function renderMatches(matches: RouteMatch[] | null): React.ReactElement | null;
-declare function useRouteComponentProps(): {
-    params: Readonly<Params<string>>;
-    loaderData: any;
-    actionData: any;
-    matches: UIMatch<unknown, unknown>[];
-};
-type RouteComponentProps = ReturnType<typeof useRouteComponentProps>;
-type RouteComponentType = React.ComponentType<RouteComponentProps>;
-declare function WithComponentProps({ children, }: {
-    children: React.ReactElement;
-}): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
-declare function withComponentProps(Component: RouteComponentType): () => React.ReactElement<{
-    params: Readonly<Params<string>>;
-    loaderData: any;
-    actionData: any;
-    matches: UIMatch<unknown, unknown>[];
-}, string | React.JSXElementConstructor<any>>;
-declare function useHydrateFallbackProps(): {
-    params: Readonly<Params<string>>;
-    loaderData: any;
-    actionData: any;
-};
-type HydrateFallbackProps = ReturnType<typeof useHydrateFallbackProps>;
-type HydrateFallbackType = React.ComponentType<HydrateFallbackProps>;
-declare function WithHydrateFallbackProps({ children, }: {
-    children: React.ReactElement;
-}): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
-declare function withHydrateFallbackProps(HydrateFallback: HydrateFallbackType): () => React.ReactElement<{
-    params: Readonly<Params<string>>;
-    loaderData: any;
-    actionData: any;
-}, string | React.JSXElementConstructor<any>>;
-declare function useErrorBoundaryProps(): {
-    params: Readonly<Params<string>>;
-    loaderData: any;
-    actionData: any;
-    error: unknown;
-};
-type ErrorBoundaryProps = ReturnType<typeof useErrorBoundaryProps>;
-type ErrorBoundaryType = React.ComponentType<ErrorBoundaryProps>;
-declare function WithErrorBoundaryProps({ children, }: {
-    children: React.ReactElement;
-}): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
-declare function withErrorBoundaryProps(ErrorBoundary: ErrorBoundaryType): () => React.ReactElement<{
-    params: Readonly<Params<string>>;
-    loaderData: any;
-    actionData: any;
-    error: unknown;
-}, string | React.JSXElementConstructor<any>>;
-
-interface IndexRouteObject {
-    caseSensitive?: AgnosticIndexRouteObject["caseSensitive"];
-    path?: AgnosticIndexRouteObject["path"];
-    id?: AgnosticIndexRouteObject["id"];
-    middleware?: AgnosticIndexRouteObject["middleware"];
-    loader?: AgnosticIndexRouteObject["loader"];
-    action?: AgnosticIndexRouteObject["action"];
-    hasErrorBoundary?: AgnosticIndexRouteObject["hasErrorBoundary"];
-    shouldRevalidate?: AgnosticIndexRouteObject["shouldRevalidate"];
-    handle?: AgnosticIndexRouteObject["handle"];
-    index: true;
-    children?: undefined;
-    element?: React.ReactNode | null;
-    hydrateFallbackElement?: React.ReactNode | null;
-    errorElement?: React.ReactNode | null;
-    Component?: React.ComponentType | null;
-    HydrateFallback?: React.ComponentType | null;
-    ErrorBoundary?: React.ComponentType | null;
-    lazy?: LazyRouteDefinition<RouteObject>;
-}
-interface NonIndexRouteObject {
-    caseSensitive?: AgnosticNonIndexRouteObject["caseSensitive"];
-    path?: AgnosticNonIndexRouteObject["path"];
-    id?: AgnosticNonIndexRouteObject["id"];
-    middleware?: AgnosticNonIndexRouteObject["middleware"];
-    loader?: AgnosticNonIndexRouteObject["loader"];
-    action?: AgnosticNonIndexRouteObject["action"];
-    hasErrorBoundary?: AgnosticNonIndexRouteObject["hasErrorBoundary"];
-    shouldRevalidate?: AgnosticNonIndexRouteObject["shouldRevalidate"];
-    handle?: AgnosticNonIndexRouteObject["handle"];
-    index?: false;
-    children?: RouteObject[];
-    element?: React.ReactNode | null;
-    hydrateFallbackElement?: React.ReactNode | null;
-    errorElement?: React.ReactNode | null;
-    Component?: React.ComponentType | null;
-    HydrateFallback?: React.ComponentType | null;
-    ErrorBoundary?: React.ComponentType | null;
-    lazy?: LazyRouteDefinition<RouteObject>;
-}
-type RouteObject = IndexRouteObject | NonIndexRouteObject;
-type DataRouteObject = RouteObject & {
-    children?: DataRouteObject[];
-    id: string;
-};
-interface RouteMatch<ParamKey extends string = string, RouteObjectType extends RouteObject = RouteObject> extends AgnosticRouteMatch<ParamKey, RouteObjectType> {
-}
-interface DataRouteMatch extends RouteMatch<string, DataRouteObject> {
-}
-type PatchRoutesOnNavigationFunctionArgs = AgnosticPatchRoutesOnNavigationFunctionArgs<RouteObject, RouteMatch>;
-type PatchRoutesOnNavigationFunction = AgnosticPatchRoutesOnNavigationFunction<RouteObject, RouteMatch>;
-interface DataRouterContextObject extends Omit<NavigationContextObject, "future"> {
-    router: Router;
-    staticContext?: StaticHandlerContext;
-    unstable_onError?: unstable_ClientOnErrorFunction;
-}
-declare const DataRouterContext: React.Context<DataRouterContextObject | null>;
-declare const DataRouterStateContext: React.Context<RouterState | null>;
-type ViewTransitionContextObject = {
-    isTransitioning: false;
-} | {
-    isTransitioning: true;
-    flushSync: boolean;
-    currentLocation: Location;
-    nextLocation: Location;
-};
-declare const ViewTransitionContext: React.Context<ViewTransitionContextObject>;
-type FetchersContextObject = Map<string, any>;
-declare const FetchersContext: React.Context<FetchersContextObject>;
-declare const AwaitContext: React.Context<TrackedPromise | null>;
-declare const AwaitContextProvider: (props: React.ComponentProps<typeof AwaitContext.Provider>) => React.FunctionComponentElement<React.ProviderProps<TrackedPromise | null>>;
-interface NavigateOptions {
-    /** Replace the current entry in the history stack instead of pushing a new one */
-    replace?: boolean;
-    /** Adds persistent client side routing state to the next location */
-    state?: any;
-    /** If you are using {@link https://api.reactrouter.com/v7/functions/react_router.ScrollRestoration.html <ScrollRestoration>}, prevent the scroll position from being reset to the top of the window when navigating */
-    preventScrollReset?: boolean;
-    /** Defines the relative path behavior for the link. "route" will use the route hierarchy so ".." will remove all URL segments of the current route pattern while "path" will use the URL path so ".." will remove one URL segment. */
-    relative?: RelativeRoutingType;
-    /** Wraps the initial state update for this navigation in a {@link https://react.dev/reference/react-dom/flushSync ReactDOM.flushSync} call instead of the default {@link https://react.dev/reference/react/startTransition React.startTransition} */
-    flushSync?: boolean;
-    /** Enables a {@link https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API View Transition} for this navigation by wrapping the final state update in `document.startViewTransition()`. If you need to apply specific styles for this view transition, you will also need to leverage the {@link https://api.reactrouter.com/v7/functions/react_router.useViewTransitionState.html useViewTransitionState()} hook.  */
-    viewTransition?: boolean;
-}
-/**
- * A Navigator is a "location changer"; it's how you get to different locations.
- *
- * Every history instance conforms to the Navigator interface, but the
- * distinction is useful primarily when it comes to the low-level `<Router>` API
- * where both the location and a navigator must be provided separately in order
- * to avoid "tearing" that may occur in a suspense-enabled app if the action
- * and/or location were to be read directly from the history instance.
- */
-interface Navigator {
-    createHref: History["createHref"];
-    encodeLocation?: History["encodeLocation"];
-    go: History["go"];
-    push(to: To, state?: any, opts?: NavigateOptions): void;
-    replace(to: To, state?: any, opts?: NavigateOptions): void;
-}
-interface NavigationContextObject {
-    basename: string;
-    navigator: Navigator;
-    static: boolean;
-    future: {};
-}
-declare const NavigationContext: React.Context<NavigationContextObject>;
-interface LocationContextObject {
-    location: Location;
-    navigationType: Action;
-}
-declare const LocationContext: React.Context<LocationContextObject>;
-interface RouteContextObject {
-    outlet: React.ReactElement | null;
-    matches: RouteMatch[];
-    isDataRoute: boolean;
-}
-declare const RouteContext: React.Context<RouteContextObject>;
-
-type unstable_ServerInstrumentation = {
-    handler?: unstable_InstrumentRequestHandlerFunction;
-    route?: unstable_InstrumentRouteFunction;
-};
-type unstable_ClientInstrumentation = {
-    router?: unstable_InstrumentRouterFunction;
-    route?: unstable_InstrumentRouteFunction;
-};
-type unstable_InstrumentRequestHandlerFunction = (handler: InstrumentableRequestHandler) => void;
-type unstable_InstrumentRouterFunction = (router: InstrumentableRouter) => void;
-type unstable_InstrumentRouteFunction = (route: InstrumentableRoute) => void;
-interface GenericInstrumentFunction {
-    (handler: () => Promise<void>, info: unknown): Promise<void>;
-}
-type InstrumentableRoute = {
-    id: string;
-    index: boolean | undefined;
-    path: string | undefined;
-    instrument(instrumentations: RouteInstrumentations): void;
-};
-type RouteInstrumentations = {
-    lazy?: InstrumentLazyFunction;
-    "lazy.loader"?: InstrumentLazyFunction;
-    "lazy.action"?: InstrumentLazyFunction;
-    "lazy.middleware"?: InstrumentLazyFunction;
-    middleware?: InstrumentRouteHandlerFunction;
-    loader?: InstrumentRouteHandlerFunction;
-    action?: InstrumentRouteHandlerFunction;
-};
-type RouteHandlerInstrumentationInfo = Readonly<{
-    request: {
-        method: string;
-        url: string;
-        headers: Pick<Headers, "get">;
-    };
-    params: LoaderFunctionArgs["params"];
-    unstable_pattern: string;
-    context: Pick<RouterContextProvider, "get">;
-}>;
-interface InstrumentLazyFunction extends GenericInstrumentFunction {
-    (handler: () => Promise<void>): Promise<void>;
-}
-interface InstrumentRouteHandlerFunction extends GenericInstrumentFunction {
-    (handler: () => Promise<void>, info: RouteHandlerInstrumentationInfo): Promise<void>;
-}
-type InstrumentableRouter = {
-    instrument(instrumentations: RouterInstrumentations): void;
-};
-type RouterInstrumentations = {
-    navigate?: InstrumentNavigateFunction;
-    fetch?: InstrumentFetchFunction;
-};
-type RouterNavigationInstrumentationInfo = Readonly<{
-    to: string | number;
-    currentUrl: string;
-    formMethod?: HTMLFormMethod;
-    formEncType?: FormEncType;
-    formData?: FormData;
-    body?: any;
-}>;
-type RouterFetchInstrumentationInfo = Readonly<{
-    href: string;
-    currentUrl: string;
-    fetcherKey: string;
-    formMethod?: HTMLFormMethod;
-    formEncType?: FormEncType;
-    formData?: FormData;
-    body?: any;
-}>;
-interface InstrumentNavigateFunction extends GenericInstrumentFunction {
-    (handler: () => Promise<void>, info: RouterNavigationInstrumentationInfo): MaybePromise<void>;
-}
-interface InstrumentFetchFunction extends GenericInstrumentFunction {
-    (handler: () => Promise<void>, info: RouterFetchInstrumentationInfo): MaybePromise<void>;
-}
-type InstrumentableRequestHandler = {
-    instrument(instrumentations: RequestHandlerInstrumentations): void;
-};
-type RequestHandlerInstrumentations = {
-    request?: InstrumentRequestHandlerFunction;
-};
-type RequestHandlerInstrumentationInfo = Readonly<{
-    request: {
-        method: string;
-        url: string;
-        headers: Pick<Headers, "get">;
-    };
-    context: Pick<RouterContextProvider, "get">;
-}>;
-interface InstrumentRequestHandlerFunction extends GenericInstrumentFunction {
-    (handler: () => Promise<void>, info: RequestHandlerInstrumentationInfo): MaybePromise<void>;
-}
-
+declare function MemoryRouter({ basename, children, initialEntries, initialIndex, }: MemoryRouterProps): React.ReactElement;
 /**
- * A Router instance manages all navigation and data loading/mutations
+ * @category Types
  */
-interface Router {
+interface NavigateProps {
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Return the basename for the router
+     * The path to navigate to. This can be a string or a {@link Path} object
      */
-    get basename(): RouterInit["basename"];
+    to: To;
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Return the future config for the router
+     * Whether to replace the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
+     * stack
      */
-    get future(): FutureConfig;
+    replace?: boolean;
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Return the current state of the router
+     * State to pass to the new {@link Location} to store in [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state).
      */
-    get state(): RouterState;
+    state?: any;
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Return the routes for this router instance
+     * How to interpret relative routing in the `to` prop.
+     * See {@link RelativeRoutingType}.
      */
-    get routes(): AgnosticDataRouteObject[];
+    relative?: RelativeRoutingType;
+}
+/**
+ * A component-based version of {@link useNavigate} to use in a
+ * [`React.Component` class](https://react.dev/reference/react/Component) where
+ * hooks cannot be used.
+ *
+ * It's recommended to avoid using this component in favor of {@link useNavigate}.
+ *
+ * @example
+ * <Navigate to="/tasks" />
+ *
+ * @public
+ * @category Components
+ * @param props Props
+ * @param {NavigateProps.relative} props.relative n/a
+ * @param {NavigateProps.replace} props.replace n/a
+ * @param {NavigateProps.state} props.state n/a
+ * @param {NavigateProps.to} props.to n/a
+ * @returns {void}
+ *
+ */
+declare function Navigate({ to, replace, state, relative, }: NavigateProps): null;
+/**
+ * @category Types
+ */
+interface OutletProps {
     /**
-     * @private
-     * PRIVATE - DO NOT USE
+     * Provides a context value to the element tree below the outlet. Use when
+     * the parent route needs to provide values to child routes.
      *
-     * Return the window associated with the router
-     */
-    get window(): RouterInit["window"];
-    /**
-     * @private
-     * PRIVATE - DO NOT USE
+     * ```tsx
+     * <Outlet context={myContextValue} />
+     * ```
      *
-     * Initialize the router, including adding history listeners and kicking off
-     * initial data fetches.  Returns a function to cleanup listeners and abort
-     * any in-progress loads
+     * Access the context with {@link useOutletContext}.
      */
-    initialize(): Router;
-    /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Subscribe to router.state updates
-     *
-     * @param fn function to call with the new state
-     */
-    subscribe(fn: RouterSubscriber): () => void;
+    context?: unknown;
+}
+/**
+ * Renders the matching child route of a parent route or nothing if no child
+ * route matches.
+ *
+ * @example
+ * import { Outlet } from "react-router";
+ *
+ * export default function SomeParent() {
+ *   return (
+ *     <div>
+ *       <h1>Parent Content</h1>
+ *       <Outlet />
+ *     </div>
+ *   );
+ * }
+ *
+ * @public
+ * @category Components
+ * @param props Props
+ * @param {OutletProps.context} props.context n/a
+ * @returns React element for the rendered outlet or `null` if no child route matches.
+ */
+declare function Outlet(props: OutletProps): React.ReactElement | null;
+/**
+ * @category Types
+ */
+interface PathRouteProps {
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Enable scroll restoration behavior in the router
-     *
-     * @param savedScrollPositions Object that will manage positions, in case
-     *                             it's being restored from sessionStorage
-     * @param getScrollPosition    Function to get the active Y scroll position
-     * @param getKey               Function to get the key to use for restoration
+     * Whether the path should be case-sensitive. Defaults to `false`.
      */
-    enableScrollRestoration(savedScrollPositions: Record<string, number>, getScrollPosition: GetScrollPositionFunction, getKey?: GetScrollRestorationKeyFunction): () => void;
+    caseSensitive?: NonIndexRouteObject["caseSensitive"];
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Navigate forward/backward in the history stack
-     * @param to Delta to move in the history stack
+     * The path pattern to match. If unspecified or empty, then this becomes a
+     * layout route.
      */
-    navigate(to: number): Promise<void>;
+    path?: NonIndexRouteObject["path"];
     /**
-     * Navigate to the given path
-     * @param to Path to navigate to
-     * @param opts Navigation options (method, submission, etc.)
+     * The unique identifier for this route (for use with {@link DataRouter}s)
      */
-    navigate(to: To | null, opts?: RouterNavigateOptions): Promise<void>;
+    id?: NonIndexRouteObject["id"];
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Trigger a fetcher load/submission
-     *
-     * @param key     Fetcher key
-     * @param routeId Route that owns the fetcher
-     * @param href    href to fetch
-     * @param opts    Fetcher options, (method, submission, etc.)
+     * A function that returns a promise that resolves to the route object.
+     * Used for code-splitting routes.
+     * See [`lazy`](../../start/data/route-object#lazy).
      */
-    fetch(key: string, routeId: string, href: string | null, opts?: RouterFetchOptions): Promise<void>;
+    lazy?: LazyRouteFunction<NonIndexRouteObject>;
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Trigger a revalidation of all current route loaders and fetcher loads
+     * The route middleware.
+     * See [`middleware`](../../start/data/route-object#middleware).
      */
-    revalidate(): Promise<void>;
+    middleware?: NonIndexRouteObject["middleware"];
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Utility function to create an href for the given location
-     * @param location
+     * The route loader.
+     * See [`loader`](../../start/data/route-object#loader).
      */
-    createHref(location: Location | URL): string;
+    loader?: NonIndexRouteObject["loader"];
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Utility function to URL encode a destination path according to the internal
-     * history implementation
-     * @param to
+     * The route action.
+     * See [`action`](../../start/data/route-object#action).
      */
-    encodeLocation(to: To): Path;
+    action?: NonIndexRouteObject["action"];
+    hasErrorBoundary?: NonIndexRouteObject["hasErrorBoundary"];
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Get/create a fetcher for the given key
-     * @param key
+     * The route shouldRevalidate function.
+     * See [`shouldRevalidate`](../../start/data/route-object#shouldRevalidate).
      */
-    getFetcher<TData = any>(key: string): Fetcher<TData>;
+    shouldRevalidate?: NonIndexRouteObject["shouldRevalidate"];
     /**
-     * @internal
-     * PRIVATE - DO NOT USE
-     *
-     * Reset the fetcher for a given key
-     * @param key
+     * The route handle.
      */
-    resetFetcher(key: string, opts?: {
-        reason?: unknown;
-    }): void;
+    handle?: NonIndexRouteObject["handle"];
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Delete the fetcher for a given key
-     * @param key
+     * Whether this is an index route.
      */
-    deleteFetcher(key: string): void;
+    index?: false;
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Cleanup listeners and abort any in-progress loads
+     * Child Route components
      */
-    dispose(): void;
+    children?: React.ReactNode;
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Get a navigation blocker
-     * @param key The identifier for the blocker
-     * @param fn The blocker function implementation
+     * The React element to render when this Route matches.
+     * Mutually exclusive with `Component`.
      */
-    getBlocker(key: string, fn: BlockerFunction): Blocker;
+    element?: React.ReactNode | null;
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Delete a navigation blocker
-     * @param key The identifier for the blocker
+     * The React element to render while this router is loading data.
+     * Mutually exclusive with `HydrateFallback`.
      */
-    deleteBlocker(key: string): void;
+    hydrateFallbackElement?: React.ReactNode | null;
     /**
-     * @private
-     * PRIVATE DO NOT USE
-     *
-     * Patch additional children routes into an existing parent route
-     * @param routeId The parent route id or a callback function accepting `patch`
-     *                to perform batch patching
-     * @param children The additional children routes
-     * @param unstable_allowElementMutations Allow mutation or route elements on
-     *                                       existing routes. Intended for RSC-usage
-     *                                       only.
+     * The React element to render at this route if an error occurs.
+     * Mutually exclusive with `ErrorBoundary`.
      */
-    patchRoutes(routeId: string | null, children: AgnosticRouteObject[], unstable_allowElementMutations?: boolean): void;
+    errorElement?: React.ReactNode | null;
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * HMR needs to pass in-flight route updates to React Router
-     * TODO: Replace this with granular route update APIs (addRoute, updateRoute, deleteRoute)
+     * The React Component to render when this route matches.
+     * Mutually exclusive with `element`.
      */
-    _internalSetRoutes(routes: AgnosticRouteObject[]): void;
+    Component?: React.ComponentType | null;
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Cause subscribers to re-render.  This is used to force a re-render.
+     * The React Component to render while this router is loading data.
+     * Mutually exclusive with `hydrateFallbackElement`.
      */
-    _internalSetStateDoNotUseOrYouWillBreakYourApp(state: Partial<RouterState>): void;
+    HydrateFallback?: React.ComponentType | null;
     /**
-     * @private
-     * PRIVATE - DO NOT USE
-     *
-     * Internal fetch AbortControllers accessed by unit tests
+     * The React Component to render at this route if an error occurs.
+     * Mutually exclusive with `errorElement`.
      */
-    _internalFetchControllers: Map<string, AbortController>;
+    ErrorBoundary?: React.ComponentType | null;
 }
 /**
- * State maintained internally by the router.  During a navigation, all states
- * reflect the "old" location unless otherwise noted.
+ * @category Types
  */
-interface RouterState {
+interface LayoutRouteProps extends PathRouteProps {
+}
+/**
+ * @category Types
+ */
+interface IndexRouteProps {
     /**
-     * The action of the most recent navigation
+     * Whether the path should be case-sensitive. Defaults to `false`.
      */
-    historyAction: Action;
+    caseSensitive?: IndexRouteObject["caseSensitive"];
     /**
-     * The current location reflected by the router
+     * The path pattern to match. If unspecified or empty, then this becomes a
+     * layout route.
      */
-    location: Location;
+    path?: IndexRouteObject["path"];
     /**
-     * The current set of route matches
+     * The unique identifier for this route (for use with {@link DataRouter}s)
      */
-    matches: AgnosticDataRouteMatch[];
+    id?: IndexRouteObject["id"];
     /**
-     * Tracks whether we've completed our initial data load
+     * A function that returns a promise that resolves to the route object.
+     * Used for code-splitting routes.
+     * See [`lazy`](../../start/data/route-object#lazy).
      */
-    initialized: boolean;
+    lazy?: LazyRouteFunction<IndexRouteObject>;
     /**
-     * Current scroll position we should start at for a new view
-     *  - number -> scroll position to restore to
-     *  - false -> do not restore scroll at all (used during submissions/revalidations)
-     *  - null -> don't have a saved position, scroll to hash or top of page
+     * The route middleware.
+     * See [`middleware`](../../start/data/route-object#middleware).
      */
-    restoreScrollPosition: number | false | null;
+    middleware?: IndexRouteObject["middleware"];
     /**
-     * Indicate whether this navigation should skip resetting the scroll position
-     * if we are unable to restore the scroll position
+     * The route loader.
+     * See [`loader`](../../start/data/route-object#loader).
      */
-    preventScrollReset: boolean;
+    loader?: IndexRouteObject["loader"];
     /**
-     * Tracks the state of the current navigation
+     * The route action.
+     * See [`action`](../../start/data/route-object#action).
      */
-    navigation: Navigation;
+    action?: IndexRouteObject["action"];
+    hasErrorBoundary?: IndexRouteObject["hasErrorBoundary"];
     /**
-     * Tracks any in-progress revalidations
+     * The route shouldRevalidate function.
+     * See [`shouldRevalidate`](../../start/data/route-object#shouldRevalidate).
      */
-    revalidation: RevalidationState;
+    shouldRevalidate?: IndexRouteObject["shouldRevalidate"];
     /**
-     * Data from the loaders for the current matches
+     * The route handle.
      */
-    loaderData: RouteData;
+    handle?: IndexRouteObject["handle"];
     /**
-     * Data from the action for the current matches
+     * Whether this is an index route.
      */
-    actionData: RouteData | null;
+    index: true;
     /**
-     * Errors caught from loaders for the current matches
+     * Child Route components
      */
-    errors: RouteData | null;
+    children?: undefined;
     /**
-     * Map of current fetchers
+     * The React element to render when this Route matches.
+     * Mutually exclusive with `Component`.
      */
-    fetchers: Map<string, Fetcher>;
+    element?: React.ReactNode | null;
     /**
-     * Map of current blockers
+     * The React element to render while this router is loading data.
+     * Mutually exclusive with `HydrateFallback`.
      */
-    blockers: Map<string, Blocker>;
+    hydrateFallbackElement?: React.ReactNode | null;
+    /**
+     * The React element to render at this route if an error occurs.
+     * Mutually exclusive with `ErrorBoundary`.
+     */
+    errorElement?: React.ReactNode | null;
+    /**
+     * The React Component to render when this route matches.
+     * Mutually exclusive with `element`.
+     */
+    Component?: React.ComponentType | null;
+    /**
+     * The React Component to render while this router is loading data.
+     * Mutually exclusive with `hydrateFallbackElement`.
+     */
+    HydrateFallback?: React.ComponentType | null;
+    /**
+     * The React Component to render at this route if an error occurs.
+     * Mutually exclusive with `errorElement`.
+     */
+    ErrorBoundary?: React.ComponentType | null;
 }
+type RouteProps = PathRouteProps | LayoutRouteProps | IndexRouteProps;
 /**
- * Data that can be passed into hydrate a Router from SSR
+ * Configures an element to render when a pattern matches the current location.
+ * It must be rendered within a {@link Routes} element. Note that these routes
+ * do not participate in data loading, actions, code splitting, or any other
+ * route module features.
+ *
+ * @example
+ * // Usually used in a declarative router
+ * function App() {
+ *   return (
+ *     <BrowserRouter>
+ *       <Routes>
+ *         <Route index element={<StepOne />} />
+ *         <Route path="step-2" element={<StepTwo />} />
+ *         <Route path="step-3" element={<StepThree />} />
+ *       </Routes>
+ *    </BrowserRouter>
+ *   );
+ * }
+ *
+ * // But can be used with a data router as well if you prefer the JSX notation
+ * const routes = createRoutesFromElements(
+ *   <>
+ *     <Route index loader={step1Loader} Component={StepOne} />
+ *     <Route path="step-2" loader={step2Loader} Component={StepTwo} />
+ *     <Route path="step-3" loader={step3Loader} Component={StepThree} />
+ *   </>
+ * );
+ *
+ * const router = createBrowserRouter(routes);
+ *
+ * function App() {
+ *   return <RouterProvider router={router} />;
+ * }
+ *
+ * @public
+ * @category Components
+ * @param props Props
+ * @param {PathRouteProps.action} props.action n/a
+ * @param {PathRouteProps.caseSensitive} props.caseSensitive n/a
+ * @param {PathRouteProps.Component} props.Component n/a
+ * @param {PathRouteProps.children} props.children n/a
+ * @param {PathRouteProps.element} props.element n/a
+ * @param {PathRouteProps.ErrorBoundary} props.ErrorBoundary n/a
+ * @param {PathRouteProps.errorElement} props.errorElement n/a
+ * @param {PathRouteProps.handle} props.handle n/a
+ * @param {PathRouteProps.HydrateFallback} props.HydrateFallback n/a
+ * @param {PathRouteProps.hydrateFallbackElement} props.hydrateFallbackElement n/a
+ * @param {PathRouteProps.id} props.id n/a
+ * @param {PathRouteProps.index} props.index n/a
+ * @param {PathRouteProps.lazy} props.lazy n/a
+ * @param {PathRouteProps.loader} props.loader n/a
+ * @param {PathRouteProps.path} props.path n/a
+ * @param {PathRouteProps.shouldRevalidate} props.shouldRevalidate n/a
+ * @returns {void}
  */
-type HydrationState = Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>;
+declare function Route(props: RouteProps): React.ReactElement | null;
 /**
- * Future flags to toggle new feature behavior
+ * @category Types
  */
-interface FutureConfig {
+interface RouterProps {
+    /**
+     * The base path for the application. This is prepended to all locations
+     */
+    basename?: string;
+    /**
+     * Nested {@link Route} elements describing the route tree
+     */
+    children?: React.ReactNode;
+    /**
+     * The location to match against. Defaults to the current location.
+     * This can be a string or a {@link Location} object.
+     */
+    location: Partial<Location> | string;
+    /**
+     * The type of navigation that triggered this `location` change.
+     * Defaults to {@link NavigationType.Pop}.
+     */
+    navigationType?: Action;
+    /**
+     * The navigator to use for navigation. This is usually a history object
+     * or a custom navigator that implements the {@link Navigator} interface.
+     */
+    navigator: Navigator;
+    /**
+     * Whether this router is static or not (used for SSR). If `true`, the router
+     * will not be reactive to location changes.
+     */
+    static?: boolean;
 }
 /**
- * Initialization options for createRouter
+ * Provides location context for the rest of the app.
+ *
+ * Note: You usually won't render a `<Router>` directly. Instead, you'll render a
+ * router that is more specific to your environment such as a {@link BrowserRouter}
+ * in web browsers or a {@link ServerRouter} for server rendering.
+ *
+ * @public
+ * @category Declarative Routers
+ * @mode declarative
+ * @param props Props
+ * @param {RouterProps.basename} props.basename n/a
+ * @param {RouterProps.children} props.children n/a
+ * @param {RouterProps.location} props.location n/a
+ * @param {RouterProps.navigationType} props.navigationType n/a
+ * @param {RouterProps.navigator} props.navigator n/a
+ * @param {RouterProps.static} props.static n/a
+ * @returns React element for the rendered router or `null` if the location does
+ * not match the {@link props.basename}
  */
-interface RouterInit {
-    routes: AgnosticRouteObject[];
-    history: History;
-    basename?: string;
-    getContext?: () => MaybePromise<RouterContextProvider>;
-    unstable_instrumentations?: unstable_ClientInstrumentation[];
-    mapRouteProperties?: MapRoutePropertiesFunction;
-    future?: Partial<FutureConfig>;
-    hydrationRouteProperties?: string[];
-    hydrationData?: HydrationState;
-    window?: Window;
-    dataStrategy?: DataStrategyFunction;
-    patchRoutesOnNavigation?: AgnosticPatchRoutesOnNavigationFunction;
-}
+declare function Router({ basename: basenameProp, children, location: locationProp, navigationType, navigator, static: staticProp, }: RouterProps): React.ReactElement | null;
 /**
- * State returned from a server-side query() call
+ * @category Types
  */
-interface StaticHandlerContext {
-    basename: Router["basename"];
-    location: RouterState["location"];
-    matches: RouterState["matches"];
-    loaderData: RouterState["loaderData"];
-    actionData: RouterState["actionData"];
-    errors: RouterState["errors"];
-    statusCode: number;
-    loaderHeaders: Record<string, Headers>;
-    actionHeaders: Record<string, Headers>;
-    _deepestRenderedBoundaryId?: string | null;
+interface RoutesProps {
+    /**
+     * Nested {@link Route} elements
+     */
+    children?: React.ReactNode;
+    /**
+     * The {@link Location} to match against. Defaults to the current location.
+     */
+    location?: Partial<Location> | string;
 }
 /**
- * A StaticHandler instance manages a singular SSR navigation/fetch event
+ * Renders a branch of {@link Route | `<Route>`s} that best matches the current
+ * location. Note that these routes do not participate in [data loading](../../start/framework/route-module#loader),
+ * [`action`](../../start/framework/route-module#action), code splitting, or
+ * any other [route module](../../start/framework/route-module) features.
+ *
+ * @example
+ * import { Route, Routes } from "react-router";
+ *
+ * <Routes>
+ *   <Route index element={<StepOne />} />
+ *   <Route path="step-2" element={<StepTwo />} />
+ *   <Route path="step-3" element={<StepThree />}>
+ * </Routes>
+ *
+ * @public
+ * @category Components
+ * @param props Props
+ * @param {RoutesProps.children} props.children n/a
+ * @param {RoutesProps.location} props.location n/a
+ * @returns React element for the rendered routes or `null` if no route matches
  */
-interface StaticHandler {
-    dataRoutes: AgnosticDataRouteObject[];
-    query(request: Request, opts?: {
-        requestContext?: unknown;
-        filterMatchesToLoad?: (match: AgnosticDataRouteMatch) => boolean;
-        skipLoaderErrorBubbling?: boolean;
-        skipRevalidation?: boolean;
-        dataStrategy?: DataStrategyFunction<unknown>;
-        generateMiddlewareResponse?: (query: (r: Request, args?: {
-            filterMatchesToLoad?: (match: AgnosticDataRouteMatch) => boolean;
-        }) => Promise<StaticHandlerContext | Response>) => MaybePromise<Response>;
-    }): Promise<StaticHandlerContext | Response>;
-    queryRoute(request: Request, opts?: {
-        routeId?: string;
-        requestContext?: unknown;
-        dataStrategy?: DataStrategyFunction<unknown>;
-        generateMiddlewareResponse?: (queryRoute: (r: Request) => Promise<Response>) => MaybePromise<Response>;
-    }): Promise<any>;
+declare function Routes({ children, location, }: RoutesProps): React.ReactElement | null;
+interface AwaitResolveRenderFunction<Resolve = any> {
+    (data: Awaited<Resolve>): React.ReactNode;
 }
-type ViewTransitionOpts = {
+/**
+ * @category Types
+ */
+interface AwaitProps<Resolve> {
+    /**
+     * When using a function, the resolved value is provided as the parameter.
+     *
+     * ```tsx [2]
+     * <Await resolve={reviewsPromise}>
+     *   {(resolvedReviews) => <Reviews items={resolvedReviews} />}
+     * </Await>
+     * ```
+     *
+     * When using React elements, {@link useAsyncValue} will provide the
+     * resolved value:
+     *
+     * ```tsx [2]
+     * <Await resolve={reviewsPromise}>
+     *   <Reviews />
+     * </Await>
+     *
+     * function Reviews() {
+     *   const resolvedReviews = useAsyncValue();
+     *   return <div>...</div>;
+     * }
+     * ```
+     */
+    children: React.ReactNode | AwaitResolveRenderFunction<Resolve>;
+    /**
+     * The error element renders instead of the `children` when the [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+     * rejects.
+     *
+     * ```tsx
+     * <Await
+     *   errorElement={<div>Oops</div>}
+     *   resolve={reviewsPromise}
+     * >
+     *   <Reviews />
+     * </Await>
+     * ```
+     *
+     * To provide a more contextual error, you can use the {@link useAsyncError} in a
+     * child component
+     *
+     * ```tsx
+     * <Await
+     *   errorElement={<ReviewsError />}
+     *   resolve={reviewsPromise}
+     * >
+     *   <Reviews />
+     * </Await>
+     *
+     * function ReviewsError() {
+     *   const error = useAsyncError();
+     *   return <div>Error loading reviews: {error.message}</div>;
+     * }
+     * ```
+     *
+     * If you do not provide an `errorElement`, the rejected value will bubble up
+     * to the nearest route-level [`ErrorBoundary`](../../start/framework/route-module#errorboundary)
+     * and be accessible via the {@link useRouteError} hook.
+     */
+    errorElement?: React.ReactNode;
+    /**
+     * Takes a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+     * returned from a [`loader`](../../start/framework/route-module#loader) to be
+     * resolved and rendered.
+     *
+     * ```tsx
+     * import { Await, useLoaderData } from "react-router";
+     *
+     * export async function loader() {
+     *   let reviews = getReviews(); // not awaited
+     *   let book = await getBook();
+     *   return {
+     *     book,
+     *     reviews, // this is a promise
+     *   };
+     * }
+     *
+     * export default function Book() {
+     *   const {
+     *     book,
+     *     reviews, // this is the same promise
+     *   } = useLoaderData();
+     *
+     *   return (
+     *     <div>
+     *       <h1>{book.title}</h1>
+     *       <p>{book.description}</p>
+     *       <React.Suspense fallback={<ReviewsSkeleton />}>
+     *         <Await
+     *           // and is the promise we pass to Await
+     *           resolve={reviews}
+     *         >
+     *           <Reviews />
+     *         </Await>
+     *       </React.Suspense>
+     *     </div>
+     *   );
+     * }
+     * ```
+     */
+    resolve: Resolve;
+}
+/**
+ * Used to render promise values with automatic error handling.
+ *
+ * **Note:** `<Await>` expects to be rendered inside a [`<React.Suspense>`](https://react.dev/reference/react/Suspense)
+ *
+ * @example
+ * import { Await, useLoaderData } from "react-router";
+ *
+ * export async function loader() {
+ *   // not awaited
+ *   const reviews = getReviews();
+ *   // awaited (blocks the transition)
+ *   const book = await fetch("/api/book").then((res) => res.json());
+ *   return { book, reviews };
+ * }
+ *
+ * function Book() {
+ *   const { book, reviews } = useLoaderData();
+ *   return (
+ *     <div>
+ *       <h1>{book.title}</h1>
+ *       <p>{book.description}</p>
+ *       <React.Suspense fallback={<ReviewsSkeleton />}>
+ *         <Await
+ *           resolve={reviews}
+ *           errorElement={
+ *             <div>Could not load reviews 😬</div>
+ *           }
+ *           children={(resolvedReviews) => (
+ *             <Reviews items={resolvedReviews} />
+ *           )}
+ *         />
+ *       </React.Suspense>
+ *     </div>
+ *   );
+ * }
+ *
+ * @public
+ * @category Components
+ * @mode framework
+ * @mode data
+ * @param props Props
+ * @param {AwaitProps.children} props.children n/a
+ * @param {AwaitProps.errorElement} props.errorElement n/a
+ * @param {AwaitProps.resolve} props.resolve n/a
+ * @returns React element for the rendered awaited value
+ */
+declare function Await<Resolve>({ children, errorElement, resolve, }: AwaitProps<Resolve>): React.JSX.Element;
+/**
+ * Creates a route config from a React "children" object, which is usually
+ * either a `<Route>` element or an array of them. Used internally by
+ * `<Routes>` to create a route config from its children.
+ *
+ * @category Utils
+ * @mode data
+ * @param children The React children to convert into a route config
+ * @param parentPath The path of the parent route, used to generate unique IDs.
+ * @returns An array of {@link RouteObject}s that can be used with a {@link DataRouter}
+ */
+declare function createRoutesFromChildren(children: React.ReactNode, parentPath?: number[]): RouteObject[];
+/**
+ * Create route objects from JSX elements instead of arrays of objects.
+ *
+ * @example
+ * const routes = createRoutesFromElements(
+ *   <>
+ *     <Route index loader={step1Loader} Component={StepOne} />
+ *     <Route path="step-2" loader={step2Loader} Component={StepTwo} />
+ *     <Route path="step-3" loader={step3Loader} Component={StepThree} />
+ *   </>
+ * );
+ *
+ * const router = createBrowserRouter(routes);
+ *
+ * function App() {
+ *   return <RouterProvider router={router} />;
+ * }
+ *
+ * @name createRoutesFromElements
+ * @public
+ * @category Utils
+ * @mode data
+ * @param children The React children to convert into a route config
+ * @param parentPath The path of the parent route, used to generate unique IDs.
+ * This is used for internal recursion and is not intended to be used by the
+ * application developer.
+ * @returns An array of {@link RouteObject}s that can be used with a {@link DataRouter}
+ */
+declare const createRoutesFromElements: typeof createRoutesFromChildren;
+/**
+ * Renders the result of {@link matchRoutes} into a React element.
+ *
+ * @public
+ * @category Utils
+ * @param matches The array of {@link RouteMatch | route matches} to render
+ * @returns A React element that renders the matched routes or `null` if no matches
+ */
+declare function renderMatches(matches: RouteMatch[] | null): React.ReactElement | null;
+declare function useRouteComponentProps(): {
+    params: Readonly<Params<string>>;
+    loaderData: any;
+    actionData: any;
+    matches: UIMatch<unknown, unknown>[];
+};
+type RouteComponentProps = ReturnType<typeof useRouteComponentProps>;
+type RouteComponentType = React.ComponentType<RouteComponentProps>;
+declare function WithComponentProps({ children, }: {
+    children: React.ReactElement;
+}): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+declare function withComponentProps(Component: RouteComponentType): () => React.ReactElement<{
+    params: Readonly<Params<string>>;
+    loaderData: any;
+    actionData: any;
+    matches: UIMatch<unknown, unknown>[];
+}, string | React.JSXElementConstructor<any>>;
+declare function useHydrateFallbackProps(): {
+    params: Readonly<Params<string>>;
+    loaderData: any;
+    actionData: any;
+};
+type HydrateFallbackProps = ReturnType<typeof useHydrateFallbackProps>;
+type HydrateFallbackType = React.ComponentType<HydrateFallbackProps>;
+declare function WithHydrateFallbackProps({ children, }: {
+    children: React.ReactElement;
+}): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+declare function withHydrateFallbackProps(HydrateFallback: HydrateFallbackType): () => React.ReactElement<{
+    params: Readonly<Params<string>>;
+    loaderData: any;
+    actionData: any;
+}, string | React.JSXElementConstructor<any>>;
+declare function useErrorBoundaryProps(): {
+    params: Readonly<Params<string>>;
+    loaderData: any;
+    actionData: any;
+    error: unknown;
+};
+type ErrorBoundaryProps = ReturnType<typeof useErrorBoundaryProps>;
+type ErrorBoundaryType = React.ComponentType<ErrorBoundaryProps>;
+declare function WithErrorBoundaryProps({ children, }: {
+    children: React.ReactElement;
+}): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+declare function withErrorBoundaryProps(ErrorBoundary: ErrorBoundaryType): () => React.ReactElement<{
+    params: Readonly<Params<string>>;
+    loaderData: any;
+    actionData: any;
+    error: unknown;
+}, string | React.JSXElementConstructor<any>>;
+
+interface IndexRouteObject {
+    caseSensitive?: AgnosticIndexRouteObject["caseSensitive"];
+    path?: AgnosticIndexRouteObject["path"];
+    id?: AgnosticIndexRouteObject["id"];
+    middleware?: AgnosticIndexRouteObject["middleware"];
+    loader?: AgnosticIndexRouteObject["loader"];
+    action?: AgnosticIndexRouteObject["action"];
+    hasErrorBoundary?: AgnosticIndexRouteObject["hasErrorBoundary"];
+    shouldRevalidate?: AgnosticIndexRouteObject["shouldRevalidate"];
+    handle?: AgnosticIndexRouteObject["handle"];
+    index: true;
+    children?: undefined;
+    element?: React.ReactNode | null;
+    hydrateFallbackElement?: React.ReactNode | null;
+    errorElement?: React.ReactNode | null;
+    Component?: React.ComponentType | null;
+    HydrateFallback?: React.ComponentType | null;
+    ErrorBoundary?: React.ComponentType | null;
+    lazy?: LazyRouteDefinition<RouteObject>;
+}
+interface NonIndexRouteObject {
+    caseSensitive?: AgnosticNonIndexRouteObject["caseSensitive"];
+    path?: AgnosticNonIndexRouteObject["path"];
+    id?: AgnosticNonIndexRouteObject["id"];
+    middleware?: AgnosticNonIndexRouteObject["middleware"];
+    loader?: AgnosticNonIndexRouteObject["loader"];
+    action?: AgnosticNonIndexRouteObject["action"];
+    hasErrorBoundary?: AgnosticNonIndexRouteObject["hasErrorBoundary"];
+    shouldRevalidate?: AgnosticNonIndexRouteObject["shouldRevalidate"];
+    handle?: AgnosticNonIndexRouteObject["handle"];
+    index?: false;
+    children?: RouteObject[];
+    element?: React.ReactNode | null;
+    hydrateFallbackElement?: React.ReactNode | null;
+    errorElement?: React.ReactNode | null;
+    Component?: React.ComponentType | null;
+    HydrateFallback?: React.ComponentType | null;
+    ErrorBoundary?: React.ComponentType | null;
+    lazy?: LazyRouteDefinition<RouteObject>;
+}
+type RouteObject = IndexRouteObject | NonIndexRouteObject;
+type DataRouteObject = RouteObject & {
+    children?: DataRouteObject[];
+    id: string;
+};
+interface RouteMatch<ParamKey extends string = string, RouteObjectType extends RouteObject = RouteObject> extends AgnosticRouteMatch<ParamKey, RouteObjectType> {
+}
+interface DataRouteMatch extends RouteMatch<string, DataRouteObject> {
+}
+type PatchRoutesOnNavigationFunctionArgs = AgnosticPatchRoutesOnNavigationFunctionArgs<RouteObject, RouteMatch>;
+type PatchRoutesOnNavigationFunction = AgnosticPatchRoutesOnNavigationFunction<RouteObject, RouteMatch>;
+interface DataRouterContextObject extends Omit<NavigationContextObject, "future"> {
+    router: Router$1;
+    staticContext?: StaticHandlerContext;
+    unstable_onError?: unstable_ClientOnErrorFunction;
+}
+declare const DataRouterContext: React.Context<DataRouterContextObject | null>;
+declare const DataRouterStateContext: React.Context<RouterState | null>;
+type ViewTransitionContextObject = {
+    isTransitioning: false;
+} | {
+    isTransitioning: true;
+    flushSync: boolean;
     currentLocation: Location;
     nextLocation: Location;
 };
-/**
- * Subscriber function signature for changes to router state
- */
-interface RouterSubscriber {
-    (state: RouterState, opts: {
-        deletedFetchers: string[];
-        viewTransitionOpts?: ViewTransitionOpts;
-        flushSync: boolean;
-    }): void;
-}
-/**
- * Function signature for determining the key to be used in scroll restoration
- * for a given location
- */
-interface GetScrollRestorationKeyFunction {
-    (location: Location, matches: UIMatch[]): string | null;
-}
-/**
- * Function signature for determining the current scroll position
- */
-interface GetScrollPositionFunction {
-    (): number;
-}
-/**
- * - "route": relative to the route hierarchy so `..` means remove all segments
- * of the current route even if it has many. For example, a `route("posts/:id")`
- * would have both `:id` and `posts` removed from the url.
- * - "path": relative to the pathname so `..` means remove one segment of the
- * pathname. For example, a `route("posts/:id")` would have only `:id` removed
- * from the url.
- */
-type RelativeRoutingType = "route" | "path";
-type BaseNavigateOrFetchOptions = {
+declare const ViewTransitionContext: React.Context<ViewTransitionContextObject>;
+type FetchersContextObject = Map<string, any>;
+declare const FetchersContext: React.Context<FetchersContextObject>;
+declare const AwaitContext: React.Context<TrackedPromise | null>;
+declare const AwaitContextProvider: (props: React.ComponentProps<typeof AwaitContext.Provider>) => React.FunctionComponentElement<React.ProviderProps<TrackedPromise | null>>;
+interface NavigateOptions {
+    /** Replace the current entry in the history stack instead of pushing a new one */
+    replace?: boolean;
+    /** Adds persistent client side routing state to the next location */
+    state?: any;
+    /** If you are using {@link https://api.reactrouter.com/v7/functions/react_router.ScrollRestoration.html <ScrollRestoration>}, prevent the scroll position from being reset to the top of the window when navigating */
     preventScrollReset?: boolean;
+    /** Defines the relative path behavior for the link. "route" will use the route hierarchy so ".." will remove all URL segments of the current route pattern while "path" will use the URL path so ".." will remove one URL segment. */
     relative?: RelativeRoutingType;
+    /** Wraps the initial state update for this navigation in a {@link https://react.dev/reference/react-dom/flushSync ReactDOM.flushSync} call instead of the default {@link https://react.dev/reference/react/startTransition React.startTransition} */
     flushSync?: boolean;
-};
-type BaseNavigateOptions = BaseNavigateOrFetchOptions & {
-    replace?: boolean;
-    state?: any;
-    fromRouteId?: string;
+    /** Enables a {@link https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API View Transition} for this navigation by wrapping the final state update in `document.startViewTransition()`. If you need to apply specific styles for this view transition, you will also need to leverage the {@link https://api.reactrouter.com/v7/functions/react_router.useViewTransitionState.html useViewTransitionState()} hook.  */
     viewTransition?: boolean;
-};
-type BaseSubmissionOptions = {
-    formMethod?: HTMLFormMethod;
-    formEncType?: FormEncType;
-} & ({
-    formData: FormData;
-    body?: undefined;
-} | {
-    formData?: undefined;
-    body: any;
-});
-/**
- * Options for a navigate() call for a normal (non-submission) navigation
- */
-type LinkNavigateOptions = BaseNavigateOptions;
-/**
- * Options for a navigate() call for a submission navigation
- */
-type SubmissionNavigateOptions = BaseNavigateOptions & BaseSubmissionOptions;
-/**
- * Options to pass to navigate() for a navigation
- */
-type RouterNavigateOptions = LinkNavigateOptions | SubmissionNavigateOptions;
-/**
- * Options for a fetch() load
- */
-type LoadFetchOptions = BaseNavigateOrFetchOptions;
-/**
- * Options for a fetch() submission
- */
-type SubmitFetchOptions = BaseNavigateOrFetchOptions & BaseSubmissionOptions;
-/**
- * Options to pass to fetch()
- */
-type RouterFetchOptions = LoadFetchOptions | SubmitFetchOptions;
-/**
- * Potential states for state.navigation
- */
-type NavigationStates = {
-    Idle: {
-        state: "idle";
-        location: undefined;
-        formMethod: undefined;
-        formAction: undefined;
-        formEncType: undefined;
-        formData: undefined;
-        json: undefined;
-        text: undefined;
-    };
-    Loading: {
-        state: "loading";
-        location: Location;
-        formMethod: Submission["formMethod"] | undefined;
-        formAction: Submission["formAction"] | undefined;
-        formEncType: Submission["formEncType"] | undefined;
-        formData: Submission["formData"] | undefined;
-        json: Submission["json"] | undefined;
-        text: Submission["text"] | undefined;
-    };
-    Submitting: {
-        state: "submitting";
-        location: Location;
-        formMethod: Submission["formMethod"];
-        formAction: Submission["formAction"];
-        formEncType: Submission["formEncType"];
-        formData: Submission["formData"];
-        json: Submission["json"];
-        text: Submission["text"];
-    };
-};
-type Navigation = NavigationStates[keyof NavigationStates];
-type RevalidationState = "idle" | "loading";
+}
 /**
- * Potential states for fetchers
+ * A Navigator is a "location changer"; it's how you get to different locations.
+ *
+ * Every history instance conforms to the Navigator interface, but the
+ * distinction is useful primarily when it comes to the low-level `<Router>` API
+ * where both the location and a navigator must be provided separately in order
+ * to avoid "tearing" that may occur in a suspense-enabled app if the action
+ * and/or location were to be read directly from the history instance.
  */
-type FetcherStates<TData = any> = {
-    /**
-     * The fetcher is not calling a loader or action
-     *
-     * ```tsx
-     * fetcher.state === "idle"
-     * ```
-     */
-    Idle: {
-        state: "idle";
-        formMethod: undefined;
-        formAction: undefined;
-        formEncType: undefined;
-        text: undefined;
-        formData: undefined;
-        json: undefined;
-        /**
-         * If the fetcher has never been called, this will be undefined.
-         */
-        data: TData | undefined;
-    };
-    /**
-     * The fetcher is loading data from a {@link LoaderFunction | loader} from a
-     * call to {@link FetcherWithComponents.load | `fetcher.load`}.
-     *
-     * ```tsx
-     * // somewhere
-     * <button onClick={() => fetcher.load("/some/route") }>Load</button>
-     *
-     * // the state will update
-     * fetcher.state === "loading"
-     * ```
-     */
-    Loading: {
-        state: "loading";
-        formMethod: Submission["formMethod"] | undefined;
-        formAction: Submission["formAction"] | undefined;
-        formEncType: Submission["formEncType"] | undefined;
-        text: Submission["text"] | undefined;
-        formData: Submission["formData"] | undefined;
-        json: Submission["json"] | undefined;
-        data: TData | undefined;
-    };
-    /**
-      The fetcher is submitting to a {@link LoaderFunction} (GET) or {@link ActionFunction} (POST) from a {@link FetcherWithComponents.Form | `fetcher.Form`} or {@link FetcherWithComponents.submit | `fetcher.submit`}.
-  
-      ```tsx
-      // somewhere
-      <input
-        onChange={e => {
-          fetcher.submit(event.currentTarget.form, { method: "post" });
-        }}
-      />
-  
-      // the state will update
-      fetcher.state === "submitting"
-  
-      // and formData will be available
-      fetcher.formData
-      ```
-     */
-    Submitting: {
-        state: "submitting";
-        formMethod: Submission["formMethod"];
-        formAction: Submission["formAction"];
-        formEncType: Submission["formEncType"];
-        text: Submission["text"];
-        formData: Submission["formData"];
-        json: Submission["json"];
-        data: TData | undefined;
-    };
-};
-type Fetcher<TData = any> = FetcherStates<TData>[keyof FetcherStates<TData>];
-interface BlockerBlocked {
-    state: "blocked";
-    reset: () => void;
-    proceed: () => void;
-    location: Location;
+interface Navigator {
+    createHref: History["createHref"];
+    encodeLocation?: History["encodeLocation"];
+    go: History["go"];
+    push(to: To, state?: any, opts?: NavigateOptions): void;
+    replace(to: To, state?: any, opts?: NavigateOptions): void;
 }
-interface BlockerUnblocked {
-    state: "unblocked";
-    reset: undefined;
-    proceed: undefined;
-    location: undefined;
+interface NavigationContextObject {
+    basename: string;
+    navigator: Navigator;
+    static: boolean;
+    future: {};
 }
-interface BlockerProceeding {
-    state: "proceeding";
-    reset: undefined;
-    proceed: undefined;
+declare const NavigationContext: React.Context<NavigationContextObject>;
+interface LocationContextObject {
     location: Location;
+    navigationType: Action;
 }
-type Blocker = BlockerUnblocked | BlockerBlocked | BlockerProceeding;
-type BlockerFunction = (args: {
-    currentLocation: Location;
-    nextLocation: Location;
-    historyAction: Action;
-}) => boolean;
-declare const IDLE_NAVIGATION: NavigationStates["Idle"];
-declare const IDLE_FETCHER: FetcherStates["Idle"];
-declare const IDLE_BLOCKER: BlockerUnblocked;
-/**
- * Create a router and listen to history POP navigations
- */
-declare function createRouter(init: RouterInit): Router;
-interface CreateStaticHandlerOptions {
-    basename?: string;
-    mapRouteProperties?: MapRoutePropertiesFunction;
-    unstable_instrumentations?: Pick<unstable_ServerInstrumentation, "route">[];
-    future?: {};
+declare const LocationContext: React.Context<LocationContextObject>;
+interface RouteContextObject {
+    outlet: React.ReactElement | null;
+    matches: RouteMatch[];
+    isDataRoute: boolean;
 }
+declare const RouteContext: React.Context<RouteContextObject>;
 
-export { type DataStrategyFunctionArgs as $, type ActionFunctionArgs as A, type BlockerFunction as B, type RouterState as C, type DataStrategyResult as D, type ErrorBoundaryType as E, type PatchRoutesOnNavigationFunction as F, type DataRouteObject as G, type HydrationState as H, type InitialEntry as I, type StaticHandler as J, type GetScrollPositionFunction as K, type Location as L, type MiddlewareNextFunction as M, type NavigateOptions as N, type GetScrollRestorationKeyFunction as O, type Params as P, type StaticHandlerContext as Q, type RouterProviderProps as R, type ShouldRevalidateFunction as S, type To as T, type UIMatch as U, type Fetcher as V, type NavigationStates as W, type RouterSubscriber as X, type RouterNavigateOptions as Y, type RouterFetchOptions as Z, type RevalidationState as _, type RouterInit as a, FetchersContext as a$, type DataStrategyMatch as a0, type ErrorResponse as a1, type FormEncType as a2, type FormMethod as a3, type HTMLFormMethod as a4, type LazyRouteFunction as a5, type PathParam as a6, type RedirectFunction as a7, type RouterContext as a8, type ShouldRevalidateFunctionArgs as a9, type MemoryRouterOpts as aA, type MemoryRouterProps as aB, type NavigateProps as aC, type OutletProps as aD, type PathRouteProps as aE, type RouteProps as aF, type RouterProps as aG, type RoutesProps as aH, Await as aI, MemoryRouter as aJ, Navigate as aK, Outlet as aL, Route as aM, Router$1 as aN, RouterProvider as aO, Routes as aP, createMemoryRouter as aQ, createRoutesFromChildren as aR, createRoutesFromElements as aS, renderMatches as aT, type Future as aU, createBrowserHistory as aV, invariant as aW, createRouter as aX, ErrorResponseImpl as aY, DataRouterContext as aZ, DataRouterStateContext as a_, createContext as aa, createPath as ab, parsePath as ac, type unstable_ServerInstrumentation as ad, type unstable_InstrumentRequestHandlerFunction as ae, type unstable_InstrumentRouterFunction as af, type unstable_InstrumentRouteFunction as ag, IDLE_NAVIGATION as ah, IDLE_FETCHER as ai, IDLE_BLOCKER as aj, data as ak, generatePath as al, isRouteErrorResponse as am, matchPath as an, matchRoutes as ao, redirect as ap, redirectDocument as aq, replace as ar, resolvePath as as, type Navigator as at, type PatchRoutesOnNavigationFunctionArgs as au, type RouteMatch as av, AwaitContextProvider as aw, type AwaitProps as ax, type IndexRouteProps as ay, type LayoutRouteProps as az, type unstable_ClientOnErrorFunction as b, LocationContext as b0, NavigationContext as b1, RouteContext as b2, ViewTransitionContext as b3, hydrationRouteProperties as b4, mapRouteProperties as b5, WithComponentProps as b6, withComponentProps as b7, WithHydrateFallbackProps as b8, withHydrateFallbackProps as b9, WithErrorBoundaryProps as ba, withErrorBoundaryProps as bb, type RouteManifest as bc, type History as bd, type FutureConfig as be, type CreateStaticHandlerOptions as bf, RouterContextProvider as c, DataWithResponseInit as d, type MiddlewareEnabled as e, type LoaderFunctionArgs as f, type ActionFunction as g, type LoaderFunction as h, type DataRouteMatch as i, type MiddlewareFunction as j, type Router as k, type DataStrategyFunction as l, type Blocker as m, type RelativeRoutingType as n, type ParamParseKey as o, type Path as p, type PathPattern as q, type PathMatch as r, type Navigation as s, Action as t, type unstable_ClientInstrumentation as u, type RouteObject as v, type IndexRouteObject as w, type RouteComponentType as x, type HydrateFallbackType as y, type NonIndexRouteObject as z };
+export { type DataStrategyMatch as $, type ActionFunctionArgs as A, type BlockerFunction as B, type PatchRoutesOnNavigationFunction as C, type DataStrategyResult as D, type ErrorBoundaryType as E, type DataRouteObject as F, type StaticHandler as G, type HydrationState as H, type InitialEntry as I, type GetScrollPositionFunction as J, type GetScrollRestorationKeyFunction as K, type Location as L, type MiddlewareNextFunction as M, type NavigateOptions as N, type StaticHandlerContext as O, type Params as P, type Fetcher as Q, type RouterProviderProps as R, type ShouldRevalidateFunction as S, type To as T, type UIMatch as U, type NavigationStates as V, type RouterSubscriber as W, type RouterNavigateOptions as X, type RouterFetchOptions as Y, type RevalidationState as Z, type DataStrategyFunctionArgs as _, type RouterInit as a, hydrationRouteProperties as a$, type ErrorResponse as a0, type FormEncType as a1, type FormMethod as a2, type HTMLFormMethod as a3, type LazyRouteFunction as a4, type PathParam as a5, type RedirectFunction as a6, type RouterContext as a7, type ShouldRevalidateFunctionArgs as a8, createContext as a9, type RouteProps as aA, type RouterProps as aB, type RoutesProps as aC, Await as aD, MemoryRouter as aE, Navigate as aF, Outlet as aG, Route as aH, Router as aI, RouterProvider as aJ, Routes as aK, createMemoryRouter as aL, createRoutesFromChildren as aM, createRoutesFromElements as aN, renderMatches as aO, type Future as aP, createBrowserHistory as aQ, invariant as aR, createRouter as aS, ErrorResponseImpl as aT, DataRouterContext as aU, DataRouterStateContext as aV, FetchersContext as aW, LocationContext as aX, NavigationContext as aY, RouteContext as aZ, ViewTransitionContext as a_, createPath as aa, parsePath as ab, IDLE_NAVIGATION as ac, IDLE_FETCHER as ad, IDLE_BLOCKER as ae, data as af, generatePath as ag, isRouteErrorResponse as ah, matchPath as ai, matchRoutes as aj, redirect as ak, redirectDocument as al, replace as am, resolvePath as an, type Navigator as ao, type PatchRoutesOnNavigationFunctionArgs as ap, type RouteMatch as aq, AwaitContextProvider as ar, type AwaitProps as as, type IndexRouteProps as at, type LayoutRouteProps as au, type MemoryRouterOpts as av, type MemoryRouterProps as aw, type NavigateProps as ax, type OutletProps as ay, type PathRouteProps as az, type LoaderFunctionArgs as b, mapRouteProperties as b0, WithComponentProps as b1, withComponentProps as b2, WithHydrateFallbackProps as b3, withHydrateFallbackProps as b4, WithErrorBoundaryProps as b5, withErrorBoundaryProps as b6, type RouteManifest as b7, type History as b8, type FutureConfig as b9, type CreateStaticHandlerOptions as ba, type ActionFunction as c, type LoaderFunction as d, type DataRouteMatch as e, type MiddlewareFunction as f, RouterContextProvider as g, DataWithResponseInit as h, type MiddlewareEnabled as i, type Router$1 as j, type DataStrategyFunction as k, type Blocker as l, type RelativeRoutingType as m, type ParamParseKey as n, type Path as o, type PathPattern as p, type PathMatch as q, type Navigation as r, Action as s, type RouteObject as t, type unstable_ClientOnErrorFunction as u, type IndexRouteObject as v, type RouteComponentType as w, type HydrateFallbackType as x, type NonIndexRouteObject as y, type RouterState as z };