react-router 7.0.0-pre.2 → 7.0.0-pre.3

package/dist/lib/hooks.d.ts

@@ -1,411 +0,0 @@
-import * as React from "react";
-import type { NavigateOptions, RouteContextObject, RouteMatch, RouteObject } from "./context";
-import type { Location, Path, To } from "./router/history";
-import { Action as NavigationType } from "./router/history";
-import type { Blocker, BlockerFunction, RelativeRoutingType, Router as DataRouter, RevalidationState } from "./router/router";
-import type { ParamParseKey, Params, PathMatch, PathPattern, UIMatch } from "./router/utils";
-import type { SerializeFrom } from "./types";
-/**
-  Resolves a URL against the current location.
-
-  ```tsx
-  import { useHref } from "react-router"
-
-  function SomeComponent() {
-    let href = useHref("some/where");
-    // "/resolved/some/where"
-  }
-  ```
-
-  @category Hooks
- */
-export declare function useHref(to: To, { relative }?: {
-    relative?: RelativeRoutingType;
-}): string;
-/**
- * Returns true if this component is a descendant of a Router, useful to ensure
- * a component is used within a Router.
- *
- * @category Hooks
- */
-export declare function useInRouterContext(): boolean;
-/**
-  Returns the current {@link Location}. This can be useful if you'd like to perform some side effect whenever it changes.
-
-  ```tsx
-  import * as React from 'react'
-  import { useLocation } from 'react-router'
-
-  function SomeComponent() {
-    let location = useLocation()
-
-    React.useEffect(() => {
-      // Google Analytics
-      ga('send', 'pageview')
-    }, [location]);
-
-    return (
-      // ...
-    );
-  }
-  ```
-
-  @category Hooks
- */
-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.
- *
- * @category Hooks
- */
-export declare function useNavigationType(): NavigationType;
-/**
- * Returns a PathMatch object if the given pattern matches the current URL.
- * This is useful for components that need to know "active" state, e.g.
- * `<NavLink>`.
- *
- * @category Hooks
- */
-export declare function useMatch<ParamKey extends ParamParseKey<Path>, Path extends string>(pattern: PathPattern<Path> | Path): PathMatch<ParamKey> | null;
-/**
- * The interface for the navigate() function returned from useNavigate().
- */
-export interface NavigateFunction {
-    (to: To, options?: NavigateOptions): void | Promise<void>;
-    (delta: number): void | Promise<void>;
-}
-/**
-  Returns a function that lets you navigate programmatically in the browser in response to user interactions or effects.
-
-  ```tsx
-  import { useNavigate } from "react-router";
-
-  function SomeComponent() {
-    let navigate = useNavigate();
-    return (
-      <button
-        onClick={() => {
-          navigate(-1);
-        }}
-      />
-    );
-  }
-  ```
-
-  It's often better to use {@link redirect} in {@link ActionFunction | actions} and {@link LoaderFunction | loaders} than this hook.
-
-  @category Hooks
- */
-export declare function useNavigate(): NavigateFunction;
-/**
- * Returns the parent route {@link OutletProps.context | `<Outlet context>`}.
- *
- * @category Hooks
- */
-export declare function useOutletContext<Context = unknown>(): Context;
-/**
- * Returns the element for the child route at this level of the route
- * hierarchy. Used internally by `<Outlet>` to render child routes.
- *
- * @category Hooks
- */
-export declare function useOutlet(context?: unknown): React.ReactElement | null;
-/**
-  Returns an object of key/value pairs of the dynamic params from the current URL that were matched by the routes. Child routes inherit all params from their parent routes.
-
-  ```tsx
-  import { useParams } from "react-router"
-
-  function SomeComponent() {
-    let params = useParams()
-    params.postId
-  }
-  ```
-
-  Assuming a route pattern like `/posts/:postId` is matched by `/posts/123` then `params.postId` will be `"123"`.
-
-  @category Hooks
- */
-export declare function useParams<ParamsOrKey extends string | Record<string, string | undefined> = string>(): Readonly<[
-    ParamsOrKey
-] extends [string] ? Params<ParamsOrKey> : Partial<ParamsOrKey>>;
-/**
-  Resolves the pathname of the given `to` value against the current location. Similar to {@link useHref}, but returns a {@link Path} instead of a string.
-
-  ```tsx
-  import { useResolvedPath } from "react-router"
-
-  function SomeComponent() {
-    // if the user is at /dashboard/profile
-    let path = useResolvedPath("../accounts")
-    path.pathname // "/dashboard/accounts"
-    path.search // ""
-    path.hash // ""
-  }
-  ```
-
-  @category Hooks
- */
-export declare function useResolvedPath(to: To, { relative }?: {
-    relative?: RelativeRoutingType;
-}): Path;
-/**
-  Hook version of {@link Routes | `<Routes>`} that uses objects instead of components. These objects have the same properties as the component props.
-
-  The return value of `useRoutes` is either a valid React element you can use to render the route tree, or `null` if nothing matched.
-
-  ```tsx
-  import * as React from "react";
-  import { useRoutes } from "react-router";
-
-  function App() {
-    let element = useRoutes([
-      {
-        path: "/",
-        element: <Dashboard />,
-        children: [
-          {
-            path: "messages",
-            element: <DashboardMessages />,
-          },
-          { path: "tasks", element: <DashboardTasks /> },
-        ],
-      },
-      { path: "team", element: <AboutPage /> },
-    ]);
-
-    return element;
-  }
-  ```
-
- @category Hooks
- */
-export declare function useRoutes(routes: RouteObject[], locationArg?: Partial<Location> | string): React.ReactElement | null;
-/**
- * Internal implementation with accept optional param for RouterProvider usage
- *
- * @private
- * @category Hooks
- */
-export declare function useRoutesImpl(routes: RouteObject[], locationArg?: Partial<Location> | string, dataRouterState?: DataRouter["state"], future?: DataRouter["future"]): React.ReactElement | null;
-type RenderErrorBoundaryProps = React.PropsWithChildren<{
-    location: Location;
-    revalidation: RevalidationState;
-    error: any;
-    component: React.ReactNode;
-    routeContext: RouteContextObject;
-}>;
-type RenderErrorBoundaryState = {
-    location: Location;
-    revalidation: RevalidationState;
-    error: any;
-};
-export declare class RenderErrorBoundary extends React.Component<RenderErrorBoundaryProps, RenderErrorBoundaryState> {
-    constructor(props: RenderErrorBoundaryProps);
-    static getDerivedStateFromError(error: any): {
-        error: any;
-    };
-    static getDerivedStateFromProps(props: RenderErrorBoundaryProps, state: RenderErrorBoundaryState): {
-        error: any;
-        location: Location<any>;
-        revalidation: RevalidationState;
-    };
-    componentDidCatch(error: any, errorInfo: any): void;
-    render(): string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element | null | undefined;
-}
-export declare function _renderMatches(matches: RouteMatch[] | null, parentMatches?: RouteMatch[], dataRouterState?: DataRouter["state"] | null, future?: DataRouter["future"] | null): React.ReactElement | null;
-/**
- * Returns the ID for the nearest contextual route
- */
-export declare function useRouteId(): string;
-/**
-  Returns the current navigation, defaulting to an "idle" navigation when no navigation is in progress. You can use this to render pending UI (like a global spinner) or read FormData from a form navigation.
-
-  ```tsx
-  import { useNavigation } from "react-router"
-
-  function SomeComponent() {
-    let navigation = useNavigation();
-    navigation.state
-    navigation.formData
-    // etc.
-  }
-  ```
-
-  @category Hooks
- */
-export declare function useNavigation(): import("./router/router").Navigation;
-/**
-  Revalidate the data on the page for reasons outside of normal data mutations like window focus or polling on an interval.
-
-  ```tsx
-  import { useRevalidator } from "react-router";
-
-  function WindowFocusRevalidator() {
-    const revalidator = useRevalidator();
-
-    useFakeWindowFocus(() => {
-      revalidator.revalidate();
-    });
-
-    return (
-      <div hidden={revalidator.state === "idle"}>
-        Revalidating...
-      </div>
-    );
-  }
-  ```
-
-  Note that page data is already revalidated automatically after actions. If you find yourself using this for normal CRUD operations on your data in response to user interactions, you're probably not taking advantage of the other APIs like {@link useFetcher}, {@link Form}, {@link useSubmit} that do this automatically.
-
-  @category Hooks
- */
-export declare function useRevalidator(): {
-    revalidate(): Promise<void>;
-    state: RevalidationState;
-};
-/**
- * Returns the active route matches, useful for accessing loaderData for
- * parent/child routes or the route "handle" property
- *
- * @category Hooks
- */
-export declare function useMatches(): UIMatch[];
-/**
-  Returns the data from the closest route {@link LoaderFunction | loader} or {@link ClientLoaderFunction | client loader}.
-
-  ```tsx
-  import { useLoaderData } from "react-router"
-
-  export async function loader() {
-    return await fakeDb.invoices.findAll();
-  }
-
-  export default function Invoices() {
-    let invoices = useLoaderData<typeof loader>();
-    // ...
-  }
-  ```
-
-  @category Hooks
- */
-export declare function useLoaderData<T = any>(): SerializeFrom<T>;
-/**
-  Returns the loader data for a given route by route ID.
-
-  ```tsx
-  import { useRouteLoaderData } from "react-router";
-
-  function SomeComponent() {
-    const { user } = useRouteLoaderData("root");
-  }
-  ```
-
-  Route IDs are created automatically. They are simply the path of the route file relative to the app folder without the extension.
-
-  | Route Filename             | Route ID             |
-  | -------------------------- | -------------------- |
-  | `app/root.tsx`             | `"root"`             |
-  | `app/routes/teams.tsx`     | `"routes/teams"`     |
-  | `app/whatever/teams.$id.tsx` | `"whatever/teams.$id"` |
-
-  If you created an ID manually, you can use that instead:
-
-  ```tsx
-  route("/", "containers/app.tsx", { id: "app" }})
-  ```
-
-  @category Hooks
- */
-export declare function useRouteLoaderData<T = any>(routeId: string): SerializeFrom<T> | undefined;
-/**
-  Returns the action data from the most recent POST navigation form submission or `undefined` if there hasn't been one.
-
-  ```tsx
-  import { Form, useActionData } from "react-router"
-
-  export async function action({ request }) {
-    const body = await request.formData()
-    const name = body.get("visitorsName")
-    return { message: `Hello, ${name}` }
-  }
-
-  export default function Invoices() {
-    const data = useActionData()
-    return (
-      <Form method="post">
-        <input type="text" name="visitorsName" />
-        {data ? data.message : "Waiting..."}
-      </Form>
-    )
-  }
-  ```
-
-  @category Hooks
- */
-export declare function useActionData<T = any>(): SerializeFrom<T> | undefined;
-/**
-  Accesses the error thrown during an {@link ActionFunction | action}, {@link LoaderFunction | loader}, or component render to be used in a route module Error Boundary.
-
-  ```tsx
-  export function ErrorBoundary() {
-    const error = useRouteError();
-    return <div>{error.message}</div>;
-  }
-  ```
-
-  @category Hooks
- */
-export declare function useRouteError(): unknown;
-/**
-  Returns the resolved promise value from the closest {@link Await | `<Await>`}.
-
-  ```tsx
-  function SomeDescendant() {
-    const value = useAsyncValue();
-    // ...
-  }
-
-  // somewhere in your app
-  <Await resolve={somePromise}>
-    <SomeDescendant />
-  </Await>
-  ```
-
-  @category Hooks
- */
-export declare function useAsyncValue(): unknown;
-/**
-  Returns the rejection value from the closest {@link Await | `<Await>`}.
-
-  ```tsx
-  import { Await, useAsyncError } from "react-router"
-
-  function ErrorElement() {
-    const error = useAsyncError();
-    return (
-      <p>Uh Oh, something went wrong! {error.message}</p>
-    );
-  }
-
-  // somewhere in your app
-  <Await
-    resolve={promiseThatRejects}
-    errorElement={<ErrorElement />}
-  />
-  ```
-
-  @category Hooks
- */
-export declare function useAsyncError(): unknown;
-/**
- * Allow the application to block navigations within the SPA and present the
- * user a confirmation dialog to confirm the navigation.  Mostly used to avoid
- * using half-filled form data.  This does not handle hard-reloads or
- * cross-origin navigations.
- *
- * @category Hooks
- */
-export declare function useBlocker(shouldBlock: boolean | BlockerFunction): Blocker;
-export {};

package/dist/lib/router/history.d.ts

@@ -1,253 +0,0 @@
-/**
- * Actions represent the type of change to a location value.
- */
-export declare enum Action {
-    /**
-     * A POP indicates a change to an arbitrary index in the history stack, such
-     * as a back or forward navigation. It does not describe the direction of the
-     * navigation, only that the current index changed.
-     *
-     * Note: This is the default action for newly created history objects.
-     */
-    Pop = "POP",
-    /**
-     * A PUSH indicates a new entry being added to the history stack, such as when
-     * a link is clicked and a new page loads. When this happens, all subsequent
-     * entries in the stack are lost.
-     */
-    Push = "PUSH",
-    /**
-     * A REPLACE indicates the entry at the current index in the history stack
-     * being replaced by a new one.
-     */
-    Replace = "REPLACE"
-}
-/**
- * The pathname, search, and hash values of a URL.
- */
-export interface Path {
-    /**
-     * A URL pathname, beginning with a /.
-     */
-    pathname: string;
-    /**
-     * A URL search string, beginning with a ?.
-     */
-    search: string;
-    /**
-     * A URL fragment identifier, beginning with a #.
-     */
-    hash: string;
-}
-/**
- * An entry in a history stack. A location contains information about the
- * URL path, as well as possibly some arbitrary state and a key.
- */
-export interface Location<State = any> extends Path {
-    /**
-     * A value of arbitrary data associated with this location.
-     */
-    state: State;
-    /**
-     * A unique string associated with this location. May be used to safely store
-     * and retrieve data in some other storage API, like `localStorage`.
-     *
-     * Note: This value is always "default" on the initial location.
-     */
-    key: string;
-}
-/**
- * A change to the current location.
- */
-export interface Update {
-    /**
-     * The action that triggered the change.
-     */
-    action: Action;
-    /**
-     * The new location.
-     */
-    location: Location;
-    /**
-     * The delta between this location and the former location in the history stack
-     */
-    delta: number | null;
-}
-/**
- * A function that receives notifications about location changes.
- */
-export interface Listener {
-    (update: Update): void;
-}
-/**
- * Describes a location that is the destination of some navigation used in
- * {@link Link}, {@link useNavigate}, etc.
- */
-export type To = string | Partial<Path>;
-/**
- * A history is an interface to the navigation stack. The history serves as the
- * source of truth for the current location, as well as provides a set of
- * methods that may be used to change it.
- *
- * It is similar to the DOM's `window.history` object, but with a smaller, more
- * focused API.
- */
-export interface History {
-    /**
-     * The last action that modified the current location. This will always be
-     * Action.Pop when a history instance is first created. This value is mutable.
-     */
-    readonly action: Action;
-    /**
-     * The current location. This value is mutable.
-     */
-    readonly location: Location;
-    /**
-     * Returns a valid href for the given `to` value that may be used as
-     * the value of an <a href> attribute.
-     *
-     * @param to - The destination URL
-     */
-    createHref(to: To): string;
-    /**
-     * Returns a URL for the given `to` value
-     *
-     * @param to - The destination URL
-     */
-    createURL(to: To): URL;
-    /**
-     * Encode a location the same way window.history would do (no-op for memory
-     * history) so we ensure our PUSH/REPLACE navigations for data routers
-     * behave the same as POP
-     *
-     * @param to Unencoded path
-     */
-    encodeLocation(to: To): Path;
-    /**
-     * Pushes a new location onto the history stack, increasing its length by one.
-     * If there were any entries in the stack after the current one, they are
-     * lost.
-     *
-     * @param to - The new URL
-     * @param state - Data to associate with the new location
-     */
-    push(to: To, state?: any): void;
-    /**
-     * Replaces the current location in the history stack with a new one.  The
-     * location that was replaced will no longer be available.
-     *
-     * @param to - The new URL
-     * @param state - Data to associate with the new location
-     */
-    replace(to: To, state?: any): void;
-    /**
-     * Navigates `n` entries backward/forward in the history stack relative to the
-     * current index. For example, a "back" navigation would use go(-1).
-     *
-     * @param delta - The delta in the stack index
-     */
-    go(delta: number): void;
-    /**
-     * Sets up a listener that will be called whenever the current location
-     * changes.
-     *
-     * @param listener - A function that will be called when the location changes
-     * @returns unlisten - A function that may be used to stop listening
-     */
-    listen(listener: Listener): () => void;
-}
-/**
- * A user-supplied object that describes a location. Used when providing
- * entries to `createMemoryHistory` via its `initialEntries` option.
- */
-export type InitialEntry = string | Partial<Location>;
-export type MemoryHistoryOptions = {
-    initialEntries?: InitialEntry[];
-    initialIndex?: number;
-    v5Compat?: boolean;
-};
-/**
- * A memory history stores locations in memory. This is useful in stateful
- * environments where there is no web browser, such as node tests or React
- * Native.
- */
-export interface MemoryHistory extends History {
-    /**
-     * The current index in the history stack.
-     */
-    readonly index: number;
-}
-/**
- * Memory history stores the current location in memory. It is designed for use
- * in stateful non-browser environments like tests and React Native.
- */
-export declare function createMemoryHistory(options?: MemoryHistoryOptions): MemoryHistory;
-/**
- * A browser history stores the current location in regular URLs in a web
- * browser environment. This is the standard for most web apps and provides the
- * cleanest URLs the browser's address bar.
- *
- * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#browserhistory
- */
-export interface BrowserHistory extends UrlHistory {
-}
-export type BrowserHistoryOptions = UrlHistoryOptions;
-/**
- * Browser history stores the location in regular URLs. This is the standard for
- * most web apps, but it requires some configuration on the server to ensure you
- * serve the same app at multiple URLs.
- *
- * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#createbrowserhistory
- */
-export declare function createBrowserHistory(options?: BrowserHistoryOptions): BrowserHistory;
-/**
- * A hash history stores the current location in the fragment identifier portion
- * of the URL in a web browser environment.
- *
- * This is ideal for apps that do not control the server for some reason
- * (because the fragment identifier is never sent to the server), including some
- * shared hosting environments that do not provide fine-grained controls over
- * which pages are served at which URLs.
- *
- * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#hashhistory
- */
-export interface HashHistory extends UrlHistory {
-}
-export type HashHistoryOptions = UrlHistoryOptions;
-/**
- * Hash history stores the location in window.location.hash. This makes it ideal
- * for situations where you don't want to send the location to the server for
- * some reason, either because you do cannot configure it or the URL space is
- * reserved for something else.
- *
- * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#createhashhistory
- */
-export declare function createHashHistory(options?: HashHistoryOptions): HashHistory;
-/**
- * @private
- */
-export declare function invariant(value: boolean, message?: string): asserts value;
-export declare function invariant<T>(value: T | null | undefined, message?: string): asserts value is T;
-export declare function warning(cond: any, message: string): void;
-/**
- * Creates a Location object with a unique key from the given Path
- */
-export declare function createLocation(current: string | Location, to: To, state?: any, key?: string): Readonly<Location>;
-/**
- * Creates a string URL path from the given pathname, search, and hash components.
- *
- * @category Utils
- */
-export declare function createPath({ pathname, search, hash, }: Partial<Path>): string;
-/**
- * Parses a string URL path into its separate pathname, search, and hash components.
- *
- * @category Utils
- */
-export declare function parsePath(path: string): Partial<Path>;
-export interface UrlHistory extends History {
-}
-export type UrlHistoryOptions = {
-    window?: Window;
-    v5Compat?: boolean;
-};