Skip to content

Commit ef05746

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

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

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

packages/react-router/typedoc.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"entryPoints": ["./index.ts"],
2+
"entryPoints": ["./index.ts", "./dom-export.ts"],
33
"categoryOrder": [
44
"Components",
55
"Hooks",

0 commit comments

Comments
 (0)