| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171 |
- import * as React from 'react';
- import { RouterProviderProps as RouterProviderProps$1, RouterInit, unstable_ClientOnErrorFunction } from 'react-router';
- import { u as unstable_ClientInstrumentation } from './instrumentation-BB0wRuqz.js';
- export { D as unstable_DecodeActionFunction, a as unstable_DecodeFormStateFunction, b as unstable_DecodeReplyFunction, R as unstable_RSCHydratedRouter, d as unstable_RSCManifestPayload, e as unstable_RSCPayload, f as unstable_RSCRenderPayload, c as unstable_createCallServer } from './browser-BpxEZgZC.js';
- type RouterProviderProps = Omit<RouterProviderProps$1, "flushSync">;
- declare function RouterProvider(props: Omit<RouterProviderProps, "flushSync">): React.JSX.Element;
- /**
- * Props for the {@link dom.HydratedRouter} component.
- *
- * @category Types
- */
- interface HydratedRouterProps {
- /**
- * Context factory function to be passed through to {@link createBrowserRouter}.
- * This function will be called to create a fresh `context` instance on each
- * navigation/fetch and made available to
- * [`clientAction`](../../start/framework/route-module#clientAction)/[`clientLoader`](../../start/framework/route-module#clientLoader)
- * functions.
- */
- getContext?: RouterInit["getContext"];
- /**
- * Array of instrumentation objects allowing you to instrument the router and
- * individual routes prior to router initialization (and on any subsequently
- * added routes via `route.lazy` or `patchRoutesOnNavigation`). This is
- * mostly useful for observability such as wrapping navigations, fetches,
- * as well as route loaders/actions/middlewares with logging and/or performance
- * tracing. See the [docs](../../how-to/instrumentation) for more information.
- *
- * ```tsx
- * const logging = {
- * router({ instrument }) {
- * instrument({
- * navigate: (impl, { to }) => logExecution(`navigate ${to}`, impl),
- * fetch: (impl, { to }) => logExecution(`fetch ${to}`, impl)
- * });
- * },
- * route({ instrument, id }) {
- * instrument({
- * middleware: (impl, { request }) => logExecution(
- * `middleware ${request.url} (route ${id})`,
- * impl
- * ),
- * loader: (impl, { request }) => logExecution(
- * `loader ${request.url} (route ${id})`,
- * impl
- * ),
- * action: (impl, { request }) => logExecution(
- * `action ${request.url} (route ${id})`,
- * impl
- * ),
- * })
- * }
- * };
- *
- * async function logExecution(label: string, impl: () => Promise<void>) {
- * let start = performance.now();
- * console.log(`start ${label}`);
- * await impl();
- * let duration = Math.round(performance.now() - start);
- * console.log(`end ${label} (${duration}ms)`);
- * }
- *
- * startTransition(() => {
- * hydrateRoot(
- * document,
- * <HydratedRouter unstable_instrumentations={[logging]} />
- * );
- * });
- * ```
- */
- unstable_instrumentations?: unstable_ClientInstrumentation[];
- /**
- * An error handler function that will be called for any loader/action/render
- * errors that are encountered in your application. This is useful for
- * logging or reporting errors instead of the `ErrorBoundary` because it's not
- * subject to re-rendering and will only run one time per error.
- *
- * The `errorInfo` parameter is passed along from
- * [`componentDidCatch`](https://react.dev/reference/react/Component#componentdidcatch)
- * and is only present for render errors.
- *
- * ```tsx
- * <HydratedRouter unstable_onError={(error, errorInfo) => {
- * console.error(error, errorInfo);
- * reportToErrorService(error, errorInfo);
- * }} />
- * ```
- */
- unstable_onError?: unstable_ClientOnErrorFunction;
- /**
- * Control whether router state updates are internally wrapped in
- * [`React.startTransition`](https://react.dev/reference/react/startTransition).
- *
- * - When left `undefined`, all state updates are wrapped in
- * `React.startTransition`
- * - This can lead to buggy behaviors if you are wrapping your own
- * navigations/fetchers in `startTransition`.
- * - When set to `true`, {@link Link} and {@link Form} navigations will be wrapped
- * in `React.startTransition` and router state changes will be wrapped in
- * `React.startTransition` and also sent through
- * [`useOptimistic`](https://react.dev/reference/react/useOptimistic) to
- * surface mid-navigation router state changes to the UI.
- * - When set to `false`, the router will not leverage `React.startTransition` or
- * `React.useOptimistic` on any navigations or state changes.
- *
- * For more information, please see the [docs](https://reactrouter.com/explanation/react-transitions).
- */
- unstable_useTransitions?: boolean;
- }
- /**
- * Framework-mode router component to be used to hydrate a router from a
- * {@link ServerRouter}. See [`entry.client.tsx`](../framework-conventions/entry.client.tsx).
- *
- * @public
- * @category Framework Routers
- * @mode framework
- * @param props Props
- * @param {dom.HydratedRouterProps.getContext} props.getContext n/a
- * @param {dom.HydratedRouterProps.unstable_onError} props.unstable_onError n/a
- * @returns A React element that represents the hydrated application.
- */
- declare function HydratedRouter(props: HydratedRouterProps): React.JSX.Element;
- declare global {
- interface Window {
- __FLIGHT_DATA: any[];
- }
- }
- /**
- * Get the prerendered [RSC](https://react.dev/reference/rsc/server-components)
- * stream for hydration. Usually passed directly to your
- * `react-server-dom-xyz/client`'s `createFromReadableStream`.
- *
- * @example
- * import { startTransition, StrictMode } from "react";
- * import { hydrateRoot } from "react-dom/client";
- * import {
- * unstable_getRSCStream as getRSCStream,
- * unstable_RSCHydratedRouter as RSCHydratedRouter,
- * } from "react-router";
- * import type { unstable_RSCPayload as RSCPayload } from "react-router";
- *
- * createFromReadableStream(getRSCStream()).then(
- * (payload: RSCServerPayload) => {
- * startTransition(async () => {
- * hydrateRoot(
- * document,
- * <StrictMode>
- * <RSCHydratedRouter {...props} />
- * </StrictMode>,
- * {
- * // Options
- * }
- * );
- * });
- * }
- * );
- *
- * @name unstable_getRSCStream
- * @public
- * @category RSC
- * @mode data
- * @returns A [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream)
- * that contains the [RSC](https://react.dev/reference/rsc/server-components)
- * data for hydration.
- */
- declare function getRSCStream(): ReadableStream;
- export { HydratedRouter, type HydratedRouterProps, RouterProvider, type RouterProviderProps, getRSCStream as unstable_getRSCStream };
|