Skip to content

Commit 3387bc8

Browse files
committed
Include react-router/dom APIs in typedoc
1 parent e2324af commit 3387bc8

File tree

5 files changed

+11
-4
lines changed

5 files changed

+11
-4
lines changed

docs/api/data-routers/HydratedRouter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: HydratedRouter
88

99
## Summary
1010

11-
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.HydratedRouter.html)
11+
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router_dom.HydratedRouter.html)
1212

1313
Hydrates a server rendered StaticRouterProvider.
1414

packages/react-router-dom/index.ts

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
import type { RouterProviderProps } from "react-router/dom";
1+
import type {
2+
HydratedRouterProps,
3+
RouterProviderProps,
4+
} from "react-router/dom";
25
import { HydratedRouter, RouterProvider } from "react-router/dom";
36

47
// TODO: Confirm if this causes tree-shaking issues and if so, convert to named exports
58
export type * from "react-router";
69
export * from "react-router";
710

8-
export type { RouterProviderProps };
11+
export type { HydratedRouterProps, RouterProviderProps };
912
export { HydratedRouter, RouterProvider };

packages/react-router/dom-export.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
export type { RouterProviderProps } from "./lib/dom-export/dom-router-provider";
22
export { RouterProvider } from "./lib/dom-export/dom-router-provider";
3+
export type { HydratedRouterProps } from "./lib/dom-export/hydrated-router";
34
export { HydratedRouter } from "./lib/dom-export/hydrated-router";

packages/react-router/lib/dom-export/hydrated-router.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ function createHydratedRouter({
208208
return router;
209209
}
210210

211-
interface HydratedRouterProps {
211+
export interface HydratedRouterProps {
212212
/**
213213
* Context object to passed through to `createBrowserRouter` and made available
214214
* to `clientLoader`/`clientActon` functions

typedoc.json

+3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
{
22
"name": "React Router API Reference",
33
"entryPoints": ["packages/*"],
4+
"packageOptions": {
5+
"entryPoints": ["index.ts", "dom-export.ts"]
6+
},
47
"entryPointStrategy": "packages",
58
"includeVersion": false,
69
"json": "./public/dev/api.json",

0 commit comments

Comments
 (0)