react-router 6.0.0-beta.5 → 6.0.0

package/index.d.ts

@@ -1,6 +1,7 @@
 import * as React from "react";
-import { Action } from "history";
-import type { Blocker, History, InitialEntry, Location, Path, State, To } from "history";
+import type { History, InitialEntry, Location, Path, To } from "history";
+import { Action as NavigationType } from "history";
+export type { Location, Path, To, NavigationType };
 /**
  * A Navigator is a "location changer"; it's how you get to different locations.
  *
@@ -10,7 +11,7 @@ import type { Blocker, History, InitialEntry, Location, Path, State, To } from "
  * 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.
  */
-export declare type Navigator = Omit<History, "action" | "location" | "back" | "forward" | "listen">;
+export declare type Navigator = Omit<History, "action" | "location" | "back" | "forward" | "listen" | "block">;
 interface NavigationContextObject {
     basename: string;
     navigator: Navigator;
@@ -18,17 +19,15 @@ interface NavigationContextObject {
 }
 declare const NavigationContext: React.Context<NavigationContextObject>;
 interface LocationContextObject {
-    action: Action;
     location: Location;
+    navigationType: NavigationType;
 }
 declare const LocationContext: React.Context<LocationContextObject>;
-declare const RouteContext: React.Context<RouteContextObject<string>>;
-interface RouteContextObject<ParamKey extends string = string> {
+interface RouteContextObject {
     outlet: React.ReactElement | null;
-    params: Readonly<Params<ParamKey>>;
-    pathname: string;
-    route: RouteObject | null;
+    matches: RouteMatch[];
 }
+declare const RouteContext: React.Context<RouteContextObject>;
 export interface MemoryRouterProps {
     basename?: string;
     children?: React.ReactNode;
@@ -44,7 +43,7 @@ export declare function MemoryRouter({ basename, children, initialEntries, initi
 export interface NavigateProps {
     to: To;
     replace?: boolean;
-    state?: State;
+    state?: any;
 }
 /**
  * Changes the current location.
@@ -71,17 +70,32 @@ export interface RouteProps {
     index?: boolean;
     path?: string;
 }
+export interface PathRouteProps {
+    caseSensitive?: boolean;
+    children?: React.ReactNode;
+    element?: React.ReactElement | null;
+    index?: false;
+    path: string;
+}
+export interface LayoutRouteProps {
+    children?: React.ReactNode;
+    element?: React.ReactElement | null;
+}
+export interface IndexRouteProps {
+    element?: React.ReactElement | null;
+    index: true;
+}
 /**
  * Declares an element that should be rendered at a certain URL path.
  *
  * @see https://reactrouter.com/api/Route
  */
-export declare function Route(_props: RouteProps): React.ReactElement | null;
+export declare function Route(_props: PathRouteProps | LayoutRouteProps | IndexRouteProps): React.ReactElement | null;
 export interface RouterProps {
-    action?: Action;
     basename?: string;
     children?: React.ReactNode;
     location: Partial<Location> | string;
+    navigationType?: NavigationType;
     navigator: Navigator;
     static?: boolean;
 }
@@ -94,7 +108,7 @@ export interface RouterProps {
  *
  * @see https://reactrouter.com/api/Router
  */
-export declare function Router({ action, basename: basenameProp, children, location: locationProp, navigator, static: staticProp }: RouterProps): React.ReactElement | null;
+export declare function Router({ basename: basenameProp, children, location: locationProp, navigationType, navigator, static: staticProp }: RouterProps): React.ReactElement | null;
 export interface RoutesProps {
     children?: React.ReactNode;
     location?: Partial<Location> | string;
@@ -106,13 +120,6 @@ export interface RoutesProps {
  * @see https://reactrouter.com/api/Routes
  */
 export declare function Routes({ children, location }: RoutesProps): React.ReactElement | null;
-/**
- * Blocks all navigation attempts. This is useful for preventing the page from
- * changing until some condition is met, like saving form data.
- *
- * @see https://reactrouter.com/api/useBlocker
- */
-export declare function useBlocker(blocker: Blocker, when?: boolean): void;
 /**
  * Returns the full href for the given "to" value. This is useful for building
  * custom links that are also accessible and preserve right-click behavior.
@@ -137,6 +144,13 @@ export declare function useInRouterContext(): boolean;
  * @see https://reactrouter.com/api/useLocation
  */
 export declare function useLocation(): Location;
+/**
+ * Returns the current navigation action which describes how the router came to
+ * the current location, either by a pop, push, or replace on the history stack.
+ *
+ * @see https://reactrouter.com/api/useNavigationType
+ */
+export declare function useNavigationType(): NavigationType;
 /**
  * Returns true if the URL for the given "to" value matches the current URL.
  * This is useful for components that need to know "active" state, e.g.
@@ -154,7 +168,7 @@ export interface NavigateFunction {
 }
 export interface NavigateOptions {
     replace?: boolean;
-    state?: State;
+    state?: any;
 }
 /**
  * Returns an imperative method for changing the location. Used by <Link>s, but
@@ -235,6 +249,10 @@ export interface RouteMatch<ParamKey extends string = string> {
      * The portion of the URL pathname that was matched.
      */
     pathname: string;
+    /**
+     * The portion of the URL pathname that was matched before child routes.
+     */
+    pathnameBase: string;
     /**
      * The route object that was used to match.
      */
@@ -282,6 +300,10 @@ export interface PathMatch<ParamKey extends string = string> {
      * The portion of the URL pathname that was matched.
      */
     pathname: string;
+    /**
+     * The portion of the URL pathname that was matched before child routes.
+     */
+    pathnameBase: string;
     /**
      * The pattern that was used to match.
      */
@@ -300,4 +322,5 @@ export declare function matchPath<ParamKey extends string = string>(pattern: Pat
  * @see https://reactrouter.com/api/resolvePath
  */
 export declare function resolvePath(to: To, fromPathname?: string): Path;
-export {};
+/** @internal */
+export { NavigationContext as UNSAFE_NavigationContext, LocationContext as UNSAFE_LocationContext, RouteContext as UNSAFE_RouteContext };