UNPKG

1.19 kBTypeScriptView Raw
1import * as React from 'react';
2import { RouterProviderProps as RouterProviderProps$1, RouterInit } from 'react-router';
3
4type RouterProviderProps = Omit<RouterProviderProps$1, "flushSync">;
5declare function RouterProvider(props: Omit<RouterProviderProps, "flushSync">): React.JSX.Element;
6
7interface HydratedRouterProps {
8 /**
9 * Context object to passed through to `createBrowserRouter` and made available
10 * to `clientLoader`/`clientActon` functions
11 */
12 unstable_getContext?: RouterInit["unstable_getContext"];
13}
14/**
15 * Framework-mode router component to be used to to hydrate a router from a
16 * `ServerRouter`. See [`entry.client.tsx`](../api/framework-conventions/entry.client.tsx).
17 *
18 * @public
19 * @category Framework Routers
20 * @mode framework
21 * @param props Props
22 * @param props.unstable_getContext Context object to passed through to
23 * {@link createBrowserRouter} and made available to `clientLoader`/`clientAction`
24 * functions
25 * @returns A React element that represents the hydrated application.
26 */
27declare function HydratedRouter(props: HydratedRouterProps): React.JSX.Element;
28
29export { HydratedRouter, RouterProvider, type RouterProviderProps };