react-router 6.27.0 → 7.0.0-pre.1

package/dist/lib/dom/lib.d.ts

@@ -0,0 +1,940 @@
+import * as React from "react";
+import type { History, To } from "../router/history";
+import type { BlockerFunction, Fetcher, FutureConfig, GetScrollRestorationKeyFunction, HydrationState, RelativeRoutingType, Router as DataRouter } from "../router/router";
+import type { DataStrategyFunction, HTMLFormMethod } from "../router/utils";
+import "./global";
+import type { SubmitOptions, URLSearchParamsInit, SubmitTarget, FetcherSubmitOptions } from "./dom";
+import type { DiscoverBehavior, PrefetchBehavior, ScriptsProps } from "./ssr/components";
+import type { RouteObject, NavigateOptions, PatchRoutesOnNavigationFunction } from "../context";
+interface DOMRouterOpts {
+    basename?: string;
+    future?: Partial<FutureConfig>;
+    hydrationData?: HydrationState;
+    dataStrategy?: DataStrategyFunction;
+    patchRoutesOnNavigation?: PatchRoutesOnNavigationFunction;
+    window?: Window;
+}
+/**
+ * @category Routers
+ */
+export declare function createBrowserRouter(routes: RouteObject[], opts?: DOMRouterOpts): DataRouter;
+/**
+ * @category Routers
+ */
+export declare function createHashRouter(routes: RouteObject[], opts?: DOMRouterOpts): DataRouter;
+/**
+ * @category Types
+ */
+export interface BrowserRouterProps {
+    basename?: string;
+    children?: React.ReactNode;
+    window?: Window;
+}
+/**
+ * A `<Router>` for use in web browsers. Provides the cleanest URLs.
+ *
+ * @category Router Components
+ */
+export declare function BrowserRouter({ basename, children, window, }: BrowserRouterProps): React.JSX.Element;
+/**
+ * @category Types
+ */
+export interface HashRouterProps {
+    basename?: string;
+    children?: React.ReactNode;
+    window?: Window;
+}
+/**
+ * A `<Router>` for use in web browsers. Stores the location in the hash
+ * portion of the URL so it is not sent to the server.
+ *
+ * @category Router Components
+ */
+export declare function HashRouter({ basename, children, window }: HashRouterProps): React.JSX.Element;
+/**
+ * @category Types
+ */
+export interface HistoryRouterProps {
+    basename?: string;
+    children?: React.ReactNode;
+    history: History;
+}
+/**
+ * A `<Router>` that accepts a pre-instantiated history object. It's important
+ * to note that using your own history object is highly discouraged and may add
+ * two versions of the history library to your bundles unless you use the same
+ * version of the history library that React Router uses internally.
+ *
+ * @name unstable_HistoryRouter
+ * @category Router Components
+ */
+export declare function HistoryRouter({ basename, children, history, }: HistoryRouterProps): React.JSX.Element;
+export declare namespace HistoryRouter {
+    var displayName: string;
+}
+/**
+ * @category Types
+ */
+export interface LinkProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "href"> {
+    /**
+      Defines the link discovery behavior
+  
+      ```tsx
+      <Link /> // default ("render")
+      <Link discover="render" />
+      <Link discover="none" />
+      ```
+  
+      - **render** - default, discover the route when the link renders
+      - **none** - don't eagerly discover, only discover if the link is clicked
+    */
+    discover?: DiscoverBehavior;
+    /**
+      Defines the data and module prefetching behavior for the link.
+  
+      ```tsx
+      <Link /> // default
+      <Link prefetch="none" />
+      <Link prefetch="intent" />
+      <Link prefetch="render" />
+      <Link prefetch="viewport" />
+      ```
+  
+      - **none** - default, no prefetching
+      - **intent** - prefetches when the user hovers or focuses the link
+      - **render** - prefetches when the link renders
+      - **viewport** - prefetches when the link is in the viewport, very useful for mobile
+  
+      Prefetching is done with HTML `<link rel="prefetch">` tags. They are inserted after the link.
+  
+      ```tsx
+      <a href="..." />
+      <a href="..." />
+      <link rel="prefetch" /> // might conditionally render
+      ```
+  
+      Because of this, if you are using `nav :last-child` you will need to use `nav :last-of-type` so the styles don't conditionally fall off your last link (and any other similar selectors).
+     */
+    prefetch?: PrefetchBehavior;
+    /**
+      Will use document navigation instead of client side routing when the link is clicked: the browser will handle the transition normally (as if it were an `<a href>`).
+  
+      ```tsx
+      <Link to="/logout" reloadDocument />
+      ```
+     */
+    reloadDocument?: boolean;
+    /**
+      Replaces the current entry in the history stack instead of pushing a new one onto it.
+  
+      ```tsx
+      <Link replace />
+      ```
+  
+      ```
+      # with a history stack like this
+      A -> B
+  
+      # normal link click pushes a new entry
+      A -> B -> C
+  
+      # but with `replace`, B is replaced by C
+      A -> C
+      ```
+     */
+    replace?: boolean;
+    /**
+      Adds persistent client side routing state to the next location.
+  
+      ```tsx
+      <Link to="/somewhere/else" state={{ some: "value" }} />
+      ```
+  
+      The location state is accessed from the `location`.
+  
+      ```tsx
+      function SomeComp() {
+        const location = useLocation()
+        location.state; // { some: "value" }
+      }
+      ```
+  
+      This state is inaccessible on the server as it is implemented on top of [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state)
+     */
+    state?: any;
+    /**
+      Prevents the scroll position from being reset to the top of the window when the link is clicked and the app is using {@link ScrollRestoration}. This only prevents new locations reseting scroll to the top, scroll position will be restored for back/forward button navigation.
+  
+      ```tsx
+      <Link to="?tab=one" preventScrollReset />
+      ```
+     */
+    preventScrollReset?: boolean;
+    /**
+      Defines the relative path behavior for the link.
+  
+      ```tsx
+      <Link to=".." /> // default: "route"
+      <Link relative="route" />
+      <Link relative="path" />
+      ```
+  
+      Consider a route hierarchy where a parent route pattern is "blog" and a child route pattern is "blog/:slug/edit".
+  
+      - **route** - default, resolves the link relative to the route pattern. In the example above a relative link of `".."` will remove both `:slug/edit` segments back to "/blog".
+      - **path** - relative to the path so `..` will only remove one URL segment up to "/blog/:slug"
+     */
+    relative?: RelativeRoutingType;
+    /**
+      Can be a string or a partial {@link Path}:
+  
+      ```tsx
+      <Link to="/some/path" />
+  
+      <Link
+        to={{
+          pathname: "/some/path",
+          search: "?query=string",
+          hash: "#hash",
+        }}
+      />
+      ```
+     */
+    to: To;
+    /**
+      Enables a [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API) for this navigation.
+  
+      ```jsx
+      <Link to={to} viewTransition>
+        Click me
+      </Link>
+      ```
+  
+      To apply specific styles for the transition, see {@link useViewTransitionState}
+     */
+    viewTransition?: boolean;
+}
+/**
+  A progressively enhanced `<a href>` wrapper to enable navigation with client-side routing.
+
+  ```tsx
+  import { Link } from "react-router";
+
+  <Link to="/dashboard">Dashboard</Link>;
+
+  <Link
+    to={{
+      pathname: "/some/path",
+      search: "?query=string",
+      hash: "#hash",
+    }}
+  />
+  ```
+
+  @category Components
+ */
+export declare const Link: React.ForwardRefExoticComponent<LinkProps & React.RefAttributes<HTMLAnchorElement>>;
+/**
+  The object passed to {@link NavLink} `children`, `className`, and `style` prop callbacks to render and style the link based on its state.
+
+  ```
+  // className
+  <NavLink
+    to="/messages"
+    className={({ isActive, isPending }) =>
+      isPending ? "pending" : isActive ? "active" : ""
+    }
+  >
+    Messages
+  </NavLink>
+
+  // style
+  <NavLink
+    to="/messages"
+    style={({ isActive, isPending }) => {
+      return {
+        fontWeight: isActive ? "bold" : "",
+        color: isPending ? "red" : "black",
+      }
+    )}
+  />
+
+  // children
+  <NavLink to="/tasks">
+    {({ isActive, isPending }) => (
+      <span className={isActive ? "active" : ""}>Tasks</span>
+    )}
+  </NavLink>
+  ```
+
+ */
+export type NavLinkRenderProps = {
+    /**
+     * Indicates if the link's URL matches the current location.
+     */
+    isActive: boolean;
+    /**
+     * Indicates if the pending location matches the link's URL.
+     */
+    isPending: boolean;
+    /**
+     * Indicates if a view transition to the link's URL is in progress. See {@link useViewTransitionState}
+     */
+    isTransitioning: boolean;
+};
+/**
+ * @category Types
+ */
+export interface NavLinkProps extends Omit<LinkProps, "className" | "style" | "children"> {
+    /**
+      Can be regular React children or a function that receives an object with the active and pending states of the link.
+  
+      ```tsx
+      <NavLink to="/tasks">
+        {({ isActive }) => (
+          <span className={isActive ? "active" : ""}>Tasks</span>
+        )}
+      </NavLink>
+      ```
+     */
+    children?: React.ReactNode | ((props: NavLinkRenderProps) => React.ReactNode);
+    /**
+      Changes the matching logic to make it case-sensitive:
+  
+      | Link                                         | URL           | isActive |
+      | -------------------------------------------- | ------------- | -------- |
+      | `<NavLink to="/SpOnGe-bOB" />`               | `/sponge-bob` | true     |
+      | `<NavLink to="/SpOnGe-bOB" caseSensitive />` | `/sponge-bob` | false    |
+     */
+    caseSensitive?: boolean;
+    /**
+      Classes are automatically applied to NavLink that correspond to {@link NavLinkRenderProps}.
+  
+      ```css
+      a.active { color: red; }
+      a.pending { color: blue; }
+      a.transitioning {
+        view-transition-name: my-transition;
+      }
+      ```
+     */
+    className?: string | ((props: NavLinkRenderProps) => string | undefined);
+    /**
+      Changes the matching logic for the `active` and `pending` states to only match to the "end" of the {@link NavLinkProps.to}. If the URL is longer, it will no longer be considered active.
+  
+      | Link                          | URL          | isActive |
+      | ----------------------------- | ------------ | -------- |
+      | `<NavLink to="/tasks" />`     | `/tasks`     | true     |
+      | `<NavLink to="/tasks" />`     | `/tasks/123` | true     |
+      | `<NavLink to="/tasks" end />` | `/tasks`     | true     |
+      | `<NavLink to="/tasks" end />` | `/tasks/123` | false    |
+  
+      `<NavLink to="/">` is an exceptional case because _every_ URL matches `/`. To avoid this matching every single route by default, it effectively ignores the `end` prop and only matches when you're at the root route.
+     */
+    end?: boolean;
+    style?: React.CSSProperties | ((props: NavLinkRenderProps) => React.CSSProperties | undefined);
+}
+/**
+  Wraps {@link Link | `<Link>`} with additional props for styling active and pending states.
+
+  - Automatically applies classes to the link based on its active and pending states, see {@link NavLinkProps.className}.
+  - Automatically applies `aria-current="page"` to the link when the link is active. See [`aria-current`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-current) on MDN.
+
+  ```tsx
+  import { NavLink } from "react-router"
+  <NavLink to="/message" />
+  ```
+
+  States are available through the className, style, and children render props. See {@link NavLinkRenderProps}.
+
+  ```tsx
+  <NavLink
+    to="/messages"
+    className={({ isActive, isPending }) =>
+      isPending ? "pending" : isActive ? "active" : ""
+    }
+  >
+    Messages
+  </NavLink>
+  ```
+
+  @category Components
+ */
+export declare const NavLink: React.ForwardRefExoticComponent<NavLinkProps & React.RefAttributes<HTMLAnchorElement>>;
+/**
+ * Form props shared by navigations and fetchers
+ */
+interface SharedFormProps extends React.FormHTMLAttributes<HTMLFormElement> {
+    /**
+     * The HTTP verb to use when the form is submitted. Supports "get", "post",
+     * "put", "delete", and "patch".
+     *
+     * Native `<form>` only supports `get` and `post`, avoid the other verbs if
+     * you'd like to support progressive enhancement
+     */
+    method?: HTMLFormMethod;
+    /**
+     * The encoding type to use for the form submission.
+     */
+    encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain";
+    /**
+     * The URL to submit the form data to.  If `undefined`, this defaults to the closest route in context.
+     */
+    action?: string;
+    /**
+     * Determines whether the form action is relative to the route hierarchy or
+     * the pathname.  Use this if you want to opt out of navigating the route
+     * hierarchy and want to instead route based on /-delimited URL segments
+     */
+    relative?: RelativeRoutingType;
+    /**
+     * Prevent the scroll position from resetting to the top of the viewport on
+     * completion of the navigation when using the <ScrollRestoration> component
+     */
+    preventScrollReset?: boolean;
+    /**
+     * A function to call when the form is submitted. If you call
+     * `event.preventDefault()` then this form will not do anything.
+     */
+    onSubmit?: React.FormEventHandler<HTMLFormElement>;
+}
+/**
+ * Form props available to fetchers
+ * @category Types
+ */
+export interface FetcherFormProps extends SharedFormProps {
+}
+/**
+ * Form props available to navigations
+ * @category Types
+ */
+export interface FormProps extends SharedFormProps {
+    discover?: DiscoverBehavior;
+    /**
+     * Indicates a specific fetcherKey to use when using `navigate={false}` so you
+     * can pick up the fetcher's state in a different component in a {@link
+     * useFetcher}.
+     */
+    fetcherKey?: string;
+    /**
+     * Skips the navigation and uses a {@link useFetcher | fetcher} internally
+     * when `false`. This is essentially a shorthand for `useFetcher()` +
+     * `<fetcher.Form>` where you don't care about the resulting data in this
+     * component.
+     */
+    navigate?: boolean;
+    /**
+     * Forces a full document navigation instead of client side routing + data
+     * fetch.
+     */
+    reloadDocument?: boolean;
+    /**
+     * Replaces the current entry in the browser history stack when the form
+     * navigates. Use this if you don't want the user to be able to click "back"
+     * to the page with the form on it.
+     */
+    replace?: boolean;
+    /**
+     * State object to add to the history stack entry for this navigation
+     */
+    state?: any;
+    /**
+     * Enables a [View
+     * Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API)
+     * for this navigation. To apply specific styles during the transition see
+     * {@link useViewTransitionState}.
+     */
+    viewTransition?: boolean;
+}
+/**
+
+A progressively enhanced HTML [`<form>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) that submits data to actions via `fetch`, activating pending states in `useNavigation` which enables advanced user interfaces beyond a basic HTML form. After a form's action completes, all data on the page is automatically revalidated to keep the UI in sync with the data.
+
+Because it uses the HTML form API, server rendered pages are interactive at a basic level before JavaScript loads. Instead of React Router managing the submission, the browser manages the submission as well as the pending states (like the spinning favicon). After JavaScript loads, React Router takes over enabling web application user experiences.
+
+Form is most useful for submissions that should also change the URL or otherwise add an entry to the browser history stack. For forms that shouldn't manipulate the browser history stack, use [`<fetcher.Form>`][fetcher_form].
+
+```tsx
+import { Form } from "react-router";
+
+function NewEvent() {
+  return (
+    <Form action="/events" method="post">
+      <input name="title" type="text" />
+      <input name="description" type="text" />
+    </Form>
+  )
+}
+```
+
+@category Components
+*/
+export declare const Form: React.ForwardRefExoticComponent<FormProps & React.RefAttributes<HTMLFormElement>>;
+export type ScrollRestorationProps = ScriptsProps & {
+    /**
+      Defines the key used to restore scroll positions.
+  
+      ```tsx
+      <ScrollRestoration
+        getKey={(location, matches) => {
+          // default behavior
+          return location.key
+        }}
+      />
+      ```
+     */
+    getKey?: GetScrollRestorationKeyFunction;
+    storageKey?: string;
+};
+/**
+  Emulates the browser's scroll restoration on location changes. Apps should only render one of these, right before the {@link Scripts} component.
+
+  ```tsx
+  import { ScrollRestoration } from "react-router";
+
+  export default function Root() {
+    return (
+      <html>
+        <body>
+          <ScrollRestoration />
+          <Scripts />
+        </body>
+      </html>
+    );
+  }
+  ```
+
+  This component renders an inline `<script>` to prevent scroll flashing. The `nonce` prop will be passed down to the script tag to allow CSP nonce usage.
+
+  ```tsx
+  <ScrollRestoration nonce={cspNonce} />
+  ```
+
+  @category Components
+ */
+export declare function ScrollRestoration({ getKey, storageKey, ...props }: ScrollRestorationProps): React.JSX.Element | null;
+export declare namespace ScrollRestoration {
+    var displayName: string;
+}
+/**
+ * Handles the click behavior for router `<Link>` components. This is useful if
+ * you need to create custom `<Link>` components with the same click behavior we
+ * use in our exported `<Link>`.
+ *
+ * @category Hooks
+ */
+export declare function useLinkClickHandler<E extends Element = HTMLAnchorElement>(to: To, { target, replace: replaceProp, state, preventScrollReset, relative, viewTransition, }?: {
+    target?: React.HTMLAttributeAnchorTarget;
+    replace?: boolean;
+    state?: any;
+    preventScrollReset?: boolean;
+    relative?: RelativeRoutingType;
+    viewTransition?: boolean;
+}): (event: React.MouseEvent<E, MouseEvent>) => void;
+/**
+  Returns a tuple of the current URL's {@link URLSearchParams} and a function to update them. Setting the search params causes a navigation.
+
+  ```tsx
+  import { useSearchParams } from "react-router";
+
+  export function SomeComponent() {
+    const [searchParams, setSearchParams] = useSearchParams();
+    // ...
+  }
+  ```
+
+ @category Hooks
+ */
+export declare function useSearchParams(defaultInit?: URLSearchParamsInit): [URLSearchParams, SetURLSearchParams];
+/**
+  Sets new search params and causes a navigation when called.
+
+  ```tsx
+  <button
+    onClick={() => {
+      const params = new URLSearchParams();
+      params.set("someKey", "someValue");
+      setSearchParams(params, {
+        preventScrollReset: true,
+      });
+    }}
+  />
+  ```
+
+  It also supports a function for setting new search params.
+
+  ```tsx
+  <button
+    onClick={() => {
+      setSearchParams((prev) => {
+        prev.set("someKey", "someValue");
+        return prev;
+      });
+    }}
+  />
+  ```
+ */
+export type SetURLSearchParams = (nextInit?: URLSearchParamsInit | ((prev: URLSearchParams) => URLSearchParamsInit), navigateOpts?: NavigateOptions) => void;
+/**
+ * Submits a HTML `<form>` to the server without reloading the page.
+ */
+export interface SubmitFunction {
+    (
+    /**
+      Can be multiple types of elements and objects
+
+      **`HTMLFormElement`**
+
+      ```tsx
+      <Form
+        onSubmit={(event) => {
+          submit(event.currentTarget);
+        }}
+      />
+      ```
+
+      **`FormData`**
+
+      ```tsx
+      const formData = new FormData();
+      formData.append("myKey", "myValue");
+      submit(formData, { method: "post" });
+      ```
+
+      **Plain object that will be serialized as `FormData`**
+
+      ```tsx
+      submit({ myKey: "myValue" }, { method: "post" });
+      ```
+
+      **Plain object that will be serialized as JSON**
+
+      ```tsx
+      submit(
+        { myKey: "myValue" },
+        { method: "post", encType: "application/json" }
+      );
+      ```
+     */
+    target: SubmitTarget, 
+    /**
+     * Options that override the `<form>`'s own attributes. Required when
+     * submitting arbitrary data without a backing `<form>`.
+     */
+    options?: SubmitOptions): Promise<void>;
+}
+/**
+ * Submits a fetcher `<form>` to the server without reloading the page.
+ */
+export interface FetcherSubmitFunction {
+    (
+    /**
+      Can be multiple types of elements and objects
+
+      **`HTMLFormElement`**
+
+      ```tsx
+      <fetcher.Form
+        onSubmit={(event) => {
+          fetcher.submit(event.currentTarget);
+        }}
+      />
+      ```
+
+      **`FormData`**
+
+      ```tsx
+      const formData = new FormData();
+      formData.append("myKey", "myValue");
+      fetcher.submit(formData, { method: "post" });
+      ```
+
+      **Plain object that will be serialized as `FormData`**
+
+      ```tsx
+      fetcher.submit({ myKey: "myValue" }, { method: "post" });
+      ```
+
+      **Plain object that will be serialized as JSON**
+
+      ```tsx
+      fetcher.submit(
+        { myKey: "myValue" },
+        { method: "post", encType: "application/json" }
+      );
+      ```
+
+     */
+    target: SubmitTarget, options?: FetcherSubmitOptions): Promise<void>;
+}
+/**
+  The imperative version of {@link Form | `<Form>`} that lets you submit a form from code instead of a user interaction.
+
+  ```tsx
+  import { useSubmit } from "react-router";
+
+  function SomeComponent() {
+    const submit = useSubmit();
+    return (
+      <Form
+        onChange={(event) => {
+          submit(event.currentTarget);
+        }}
+      />
+    );
+  }
+  ```
+
+  @category Hooks
+ */
+export declare function useSubmit(): SubmitFunction;
+/**
+  Resolves the URL to the closest route in the component hierarchy instead of the current URL of the app.
+
+  This is used internally by {@link Form} resolve the action to the closest route, but can be used generically as well.
+
+  ```tsx
+  import { useFormAction } from "react-router";
+
+  function SomeComponent() {
+    // closest route URL
+    let action = useFormAction();
+
+    // closest route URL + "destroy"
+    let destroyAction = useFormAction("destroy");
+  }
+  ```
+
+  @category Hooks
+ */
+export declare function useFormAction(
+/**
+ * The action to append to the closest route URL.
+ */
+action?: string, { relative }?: {
+    relative?: RelativeRoutingType;
+}): string;
+/**
+The return value of `useFetcher` that keeps track of the state of a fetcher.
+
+```tsx
+let fetcher = useFetcher();
+```
+ */
+export type FetcherWithComponents<TData> = Fetcher<TData> & {
+    /**
+      Just like {@link Form} except it doesn't cause a navigation.
+  
+      ```tsx
+      function SomeComponent() {
+        const fetcher = useFetcher()
+        return (
+          <fetcher.Form method="post" action="/some/route">
+            <input type="text" />
+          </fetcher.Form>
+        )
+      }
+      ```
+     */
+    Form: React.ForwardRefExoticComponent<FetcherFormProps & React.RefAttributes<HTMLFormElement>>;
+    /**
+      Submits form data to a route. While multiple nested routes can match a URL, only the leaf route will be called.
+  
+      The `formData` can be multiple types:
+  
+      - [`FormData`][form_data] - A `FormData` instance.
+      - [`HTMLFormElement`][html_form_element] - A [`<form>`][form_element] DOM element.
+      - `Object` - An object of key/value pairs that will be converted to a `FormData` instance by default. You can pass a more complex object and serialize it as JSON by specifying `encType: "application/json"`. See [`useSubmit`][use-submit] for more details.
+  
+      If the method is `GET`, then the route [`loader`][loader] is being called and with the `formData` serialized to the url as [`URLSearchParams`][url_search_params]. If `DELETE`, `PATCH`, `POST`, or `PUT`, then the route [`action`][action] is being called with `formData` as the body.
+  
+      ```tsx
+      // Submit a FormData instance (GET request)
+      const formData = new FormData();
+      fetcher.submit(formData);
+  
+      // Submit the HTML form element
+      fetcher.submit(event.currentTarget.form, {
+        method: "POST",
+      });
+  
+      // Submit key/value JSON as a FormData instance
+      fetcher.submit(
+        { serialized: "values" },
+        { method: "POST" }
+      );
+  
+      // Submit raw JSON
+      fetcher.submit(
+        {
+          deeply: {
+            nested: {
+              json: "values",
+            },
+          },
+        },
+        {
+          method: "POST",
+          encType: "application/json",
+        }
+      );
+      ```
+     */
+    submit: FetcherSubmitFunction;
+    /**
+      Loads data from a route. Useful for loading data imperatively inside of user events outside of a normal button or form, like a combobox or search input.
+  
+      ```tsx
+      let fetcher = useFetcher()
+  
+      <input onChange={e => {
+        fetcher.load(`/search?q=${e.target.value}`)
+      }} />
+      ```
+     */
+    load: (href: string, opts?: {
+        /**
+         * Wraps the initial state update for this `fetcher.load` in a
+         * `ReactDOM.flushSync` call instead of the default `React.startTransition`.
+         * This allows you to perform synchronous DOM actions immediately after the
+         * update is flushed to the DOM.
+         */
+        flushSync?: boolean;
+    }) => Promise<void>;
+};
+/**
+  Useful for creating complex, dynamic user interfaces that require multiple, concurrent data interactions without causing a navigation.
+
+  Fetchers track their own, independent state and can be used to load data, submit forms, and generally interact with loaders and actions.
+
+  ```tsx
+  import { useFetcher } from "react-router"
+
+  function SomeComponent() {
+    let fetcher = useFetcher()
+
+    // states are available on the fetcher
+    fetcher.state // "idle" | "loading" | "submitting"
+    fetcher.data // the data returned from the action or loader
+
+    // render a form
+    <fetcher.Form method="post" />
+
+    // load data
+    fetcher.load("/some/route")
+
+    // submit data
+    fetcher.submit(someFormRef, { method: "post" })
+    fetcher.submit(someData, {
+      method: "post",
+      encType: "application/json"
+    })
+  }
+  ```
+
+  @category Hooks
+ */
+export declare function useFetcher<TData = any>({ key, }?: {
+    /**
+      By default, `useFetcher` generate a unique fetcher scoped to that component. If you want to identify a fetcher with your own key such that you can access it from elsewhere in your app, you can do that with the `key` option:
+  
+      ```tsx
+      function SomeComp() {
+        let fetcher = useFetcher({ key: "my-key" })
+        // ...
+      }
+  
+      // Somewhere else
+      function AnotherComp() {
+        // this will be the same fetcher, sharing the state across the app
+        let fetcher = useFetcher({ key: "my-key" });
+        // ...
+      }
+      ```
+     */
+    key?: string;
+}): FetcherWithComponents<TData>;
+/**
+  Returns an array of all in-flight fetchers. This is useful for components throughout the app that didn't create the fetchers but want to use their submissions to participate in optimistic UI.
+
+  ```tsx
+  import { useFetchers } from "react-router";
+
+  function SomeComponent() {
+    const fetchers = useFetchers();
+    fetchers[0].formData; // FormData
+    fetchers[0].state; // etc.
+    // ...
+  }
+  ```
+
+  @category Hooks
+ */
+export declare function useFetchers(): (Fetcher & {
+    key: string;
+})[];
+/**
+ * When rendered inside a RouterProvider, will restore scroll positions on navigations
+ */
+export declare function useScrollRestoration({ getKey, storageKey, }?: {
+    getKey?: GetScrollRestorationKeyFunction;
+    storageKey?: string;
+}): void;
+/**
+ * Setup a callback to be fired on the window's `beforeunload` event.
+ *
+ * @category Hooks
+ */
+export declare function useBeforeUnload(callback: (event: BeforeUnloadEvent) => any, options?: {
+    capture?: boolean;
+}): void;
+/**
+  Wrapper around useBlocker to show a window.confirm prompt to users instead of building a custom UI with {@link useBlocker}.
+
+  The `unstable_` flag will not be removed because this technique has a lot of rough edges and behaves very differently (and incorrectly sometimes) across browsers if users click addition back/forward navigations while the confirmation is open.  Use at your own risk.
+
+  ```tsx
+  function ImportantForm() {
+    let [value, setValue] = React.useState("");
+
+    // Block navigating elsewhere when data has been entered into the input
+    unstable_usePrompt({
+      message: "Are you sure?",
+      when: ({ currentLocation, nextLocation }) =>
+        value !== "" &&
+        currentLocation.pathname !== nextLocation.pathname,
+    });
+
+    return (
+      <Form method="post">
+        <label>
+          Enter some important data:
+          <input
+            name="data"
+            value={value}
+            onChange={(e) => setValue(e.target.value)}
+          />
+        </label>
+        <button type="submit">Save</button>
+      </Form>
+    );
+  }
+  ```
+
+  @category Hooks
+  @name unstable_usePrompt
+ */
+export declare function usePrompt({ when, message, }: {
+    when: boolean | BlockerFunction;
+    message: string;
+}): void;
+/**
+  This hook returns `true` when there is an active [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API) to the specified location. This can be used to apply finer-grained styles to elements to further customize the view transition. This requires that view transitions have been enabled for the given navigation via {@link LinkProps.viewTransition} (or the `Form`, `submit`, or `navigate` call)
+
+  @category Hooks
+  @name useViewTransitionState
+ */
+export declare function useViewTransitionState(to: To, opts?: {
+    relative?: RelativeRoutingType;
+}): boolean;
+export {};