react-router 6.0.0-beta.6 → 6.0.1

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,18 +19,15 @@ interface NavigationContextObject {
 }
 declare const NavigationContext: React.Context<NavigationContextObject>;
 interface LocationContextObject {
-    action: Action;
     location: Location;
+    navigationType: NavigationType;
 }
 declare const LocationContext: React.Context<LocationContextObject>;
-interface RouteContextObject<ParamKey extends string = string> {
+interface RouteContextObject {
     outlet: React.ReactElement | null;
-    params: Readonly<Params<ParamKey>>;
-    pathname: string;
-    pathnameBase: string;
-    route: RouteObject | null;
+    matches: RouteMatch[];
 }
-declare const RouteContext: React.Context<RouteContextObject<string>>;
+declare const RouteContext: React.Context<RouteContextObject>;
 export interface MemoryRouterProps {
     basename?: string;
     children?: React.ReactNode;
@@ -39,13 +37,13 @@ export interface MemoryRouterProps {
 /**
  * A <Router> that stores all entries in memory.
  *
- * @see https://reactrouter.com/api/MemoryRouter
+ * @see https://reactrouter.com/docs/en/v6/api#memoryrouter
  */
 export declare function MemoryRouter({ basename, children, initialEntries, initialIndex }: MemoryRouterProps): React.ReactElement;
 export interface NavigateProps {
     to: To;
     replace?: boolean;
-    state?: State;
+    state?: any;
 }
 /**
  * Changes the current location.
@@ -54,7 +52,7 @@ export interface NavigateProps {
  * able to use hooks. In functional components, we recommend you use the
  * `useNavigate` hook instead.
  *
- * @see https://reactrouter.com/api/Navigate
+ * @see https://reactrouter.com/docs/en/v6/api#navigate
  */
 export declare function Navigate({ to, replace, state }: NavigateProps): null;
 export interface OutletProps {
@@ -62,7 +60,7 @@ export interface OutletProps {
 /**
  * Renders the child route's element, if there is one.
  *
- * @see https://reactrouter.com/api/Outlet
+ * @see https://reactrouter.com/docs/en/v6/api#outlet
  */
 export declare function Outlet(_props: OutletProps): React.ReactElement | null;
 export interface RouteProps {
@@ -90,14 +88,14 @@ export interface IndexRouteProps {
 /**
  * Declares an element that should be rendered at a certain URL path.
  *
- * @see https://reactrouter.com/api/Route
+ * @see https://reactrouter.com/docs/en/v6/api#route
  */
 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;
 }
@@ -108,9 +106,9 @@ export interface RouterProps {
  * router that is more specific to your environment such as a <BrowserRouter>
  * in web browsers or a <StaticRouter> for server rendering.
  *
- * @see https://reactrouter.com/api/Router
+ * @see https://reactrouter.com/docs/en/v6/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;
@@ -119,27 +117,20 @@ export interface RoutesProps {
  * A container for a nested tree of <Route> elements that renders the branch
  * that best matches the current location.
  *
- * @see https://reactrouter.com/api/Routes
+ * @see https://reactrouter.com/docs/en/v6/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.
  *
- * @see https://reactrouter.com/api/useHref
+ * @see https://reactrouter.com/docs/en/v6/api#usehref
  */
 export declare function useHref(to: To): string;
 /**
  * Returns true if this component is a descendant of a <Router>.
  *
- * @see https://reactrouter.com/api/useInRouterContext
+ * @see https://reactrouter.com/docs/en/v6/api#useinroutercontext
  */
 export declare function useInRouterContext(): boolean;
 /**
@@ -150,15 +141,22 @@ export declare function useInRouterContext(): boolean;
  * "routing" in your app, and we'd like to know what your use case is. We may
  * be able to provide something higher-level to better suit your needs.
  *
- * @see https://reactrouter.com/api/useLocation
+ * @see https://reactrouter.com/docs/en/v6/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/docs/en/v6/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.
  * <NavLink>.
  *
- * @see https://reactrouter.com/api/useMatch
+ * @see https://reactrouter.com/docs/en/v6/api#usematch
  */
 export declare function useMatch<ParamKey extends string = string>(pattern: PathPattern | string): PathMatch<ParamKey> | null;
 /**
@@ -170,33 +168,33 @@ 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
  * may also be used by other elements to change the location.
  *
- * @see https://reactrouter.com/api/useNavigate
+ * @see https://reactrouter.com/docs/en/v6/api#usenavigate
  */
 export declare function useNavigate(): NavigateFunction;
 /**
  * Returns the element for the child route at this level of the route
  * hierarchy. Used internally by <Outlet> to render child routes.
  *
- * @see https://reactrouter.com/api/useOutlet
+ * @see https://reactrouter.com/docs/en/v6/api#useoutlet
  */
 export declare function useOutlet(): React.ReactElement | null;
 /**
  * Returns an object of key/value pairs of the dynamic params from the current
  * URL that were matched by the route path.
  *
- * @see https://reactrouter.com/api/useParams
+ * @see https://reactrouter.com/docs/en/v6/api#useparams
  */
 export declare function useParams<Key extends string = string>(): Readonly<Params<Key>>;
 /**
  * Resolves the pathname of the given `to` value against the current location.
  *
- * @see https://reactrouter.com/api/useResolvedPath
+ * @see https://reactrouter.com/docs/en/v6/api#useresolvedpath
  */
 export declare function useResolvedPath(to: To): Path;
 /**
@@ -205,7 +203,7 @@ export declare function useResolvedPath(to: To): Path;
  * elements in the tree must render an <Outlet> to render their child route's
  * element.
  *
- * @see https://reactrouter.com/api/useRoutes
+ * @see https://reactrouter.com/docs/en/v6/api#useroutes
  */
 export declare function useRoutes(routes: RouteObject[], locationArg?: Partial<Location> | string): React.ReactElement | null;
 /**
@@ -213,7 +211,7 @@ export declare function useRoutes(routes: RouteObject[], locationArg?: Partial<L
  * either a `<Route>` element or an array of them. Used internally by
  * `<Routes>` to create a route config from its children.
  *
- * @see https://reactrouter.com/api/createRoutesFromChildren
+ * @see https://reactrouter.com/docs/en/v6/api#createroutesfromchildren
  */
 export declare function createRoutesFromChildren(children: React.ReactNode): RouteObject[];
 /**
@@ -236,7 +234,7 @@ export interface RouteObject {
 /**
  * Returns a path with params interpolated.
  *
- * @see https://reactrouter.com/api/generatePath
+ * @see https://reactrouter.com/docs/en/v6/api#generatepath
  */
 export declare function generatePath(path: string, params?: Params): string;
 /**
@@ -263,7 +261,7 @@ export interface RouteMatch<ParamKey extends string = string> {
 /**
  * Matches the given routes to a location and returns the match data.
  *
- * @see https://reactrouter.com/api/matchRoutes
+ * @see https://reactrouter.com/docs/en/v6/api#matchroutes
  */
 export declare function matchRoutes(routes: RouteObject[], locationArg: Partial<Location> | string, basename?: string): RouteMatch[] | null;
 /**
@@ -315,13 +313,13 @@ export interface PathMatch<ParamKey extends string = string> {
  * Performs pattern matching on a URL pathname and returns information about
  * the match.
  *
- * @see https://reactrouter.com/api/matchPath
+ * @see https://reactrouter.com/docs/en/v6/api#matchpath
  */
 export declare function matchPath<ParamKey extends string = string>(pattern: PathPattern | string, pathname: string): PathMatch<ParamKey> | null;
 /**
  * Returns a resolved path object relative to the given pathname.
  *
- * @see https://reactrouter.com/api/resolvePath
+ * @see https://reactrouter.com/docs/en/v6/api#resolvepath
  */
 export declare function resolvePath(to: To, fromPathname?: string): Path;
 /** @internal */