@remix-run/router 1.5.0 → 1.6.0

package/dist/router.d.ts

@@ -1,6 +1,6 @@
 import type { History, Location, Path, To } from "./history";
 import { Action as HistoryAction } from "./history";
-import type { DeferredData, AgnosticDataRouteMatch, AgnosticDataRouteObject, FormEncType, FormMethod, DetectErrorBoundaryFunction, RouteData, AgnosticRouteObject, AgnosticRouteMatch, V7_FormMethod, HTMLFormMethod } from "./utils";
+import type { DeferredData, AgnosticDataRouteMatch, AgnosticDataRouteObject, FormEncType, FormMethod, DetectErrorBoundaryFunction, RouteData, AgnosticRouteObject, AgnosticRouteMatch, V7_FormMethod, HTMLFormMethod, MapRoutePropertiesFunction } from "./utils";
 /**
  * A Router instance manages all navigation and data loading/mutations
  */
@@ -69,7 +69,7 @@ export interface Router {
      * @param to Path to navigate to
      * @param opts Navigation options (method, submission, etc.)
      */
-    navigate(to: To, opts?: RouterNavigateOptions): Promise<void>;
+    navigate(to: To | null, opts?: RouterNavigateOptions): Promise<void>;
     /**
      * @internal
      * PRIVATE - DO NOT USE
@@ -81,7 +81,7 @@ export interface Router {
      * @param href    href to fetch
      * @param opts    Fetcher options, (method, submission, etc.)
      */
-    fetch(key: string, routeId: string, href: string, opts?: RouterNavigateOptions): void;
+    fetch(key: string, routeId: string, href: string | null, opts?: RouterNavigateOptions): void;
     /**
      * @internal
      * PRIVATE - DO NOT USE
@@ -240,6 +240,7 @@ export declare type HydrationState = Partial<Pick<RouterState, "loaderData" | "a
  */
 export interface FutureConfig {
     v7_normalizeFormMethod: boolean;
+    v7_prependBasename: boolean;
 }
 /**
  * Initialization options for createRouter
@@ -248,8 +249,12 @@ export interface RouterInit {
     routes: AgnosticRouteObject[];
     history: History;
     basename?: string;
+    /**
+     * @deprecated Use `mapRouteProperties` instead
+     */
     detectErrorBoundary?: DetectErrorBoundaryFunction;
-    future?: FutureConfig;
+    mapRouteProperties?: MapRoutePropertiesFunction;
+    future?: Partial<FutureConfig>;
     hydrationData?: HydrationState;
 }
 /**
@@ -307,21 +312,22 @@ export interface GetScrollRestorationKeyFunction {
 export interface GetScrollPositionFunction {
     (): number;
 }
-/**
- * Options for a navigate() call for a Link navigation
- */
-declare type LinkNavigateOptions = {
+export declare type RelativeRoutingType = "route" | "path";
+declare type BaseNavigateOptions = {
     replace?: boolean;
     state?: any;
     preventScrollReset?: boolean;
+    relative?: RelativeRoutingType;
+    fromRouteId?: string;
 };
+/**
+ * Options for a navigate() call for a Link navigation
+ */
+declare type LinkNavigateOptions = BaseNavigateOptions;
 /**
  * Options for a navigate() call for a Form navigation
  */
-declare type SubmissionNavigateOptions = {
-    replace?: boolean;
-    state?: any;
-    preventScrollReset?: boolean;
+declare type SubmissionNavigateOptions = BaseNavigateOptions & {
     formMethod?: HTMLFormMethod;
     formEncType?: FormEncType;
     formData: FormData;
@@ -432,7 +438,11 @@ export declare function createRouter(init: RouterInit): Router;
 export declare const UNSAFE_DEFERRED_SYMBOL: unique symbol;
 export interface CreateStaticHandlerOptions {
     basename?: string;
+    /**
+     * @deprecated Use `mapRouteProperties` instead
+     */
     detectErrorBoundary?: DetectErrorBoundaryFunction;
+    mapRouteProperties?: MapRoutePropertiesFunction;
 }
 export declare function createStaticHandler(routes: AgnosticRouteObject[], opts?: CreateStaticHandlerOptions): StaticHandler;
 /**