@tanstack/react-router 0.0.1-beta.28 → 0.0.1-beta.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,17 +9,9 @@
9
9
  * @license MIT
10
10
  */
11
11
  import * as React from 'react';
12
- import { AnyRouteConfig, RouterContext, RouteConfig, AnyAllRouteInfo, AllRouteInfo, RouterState, RouteMatch, RouteInfo, DefaultAllRouteInfo, AnyRouteInfo, ResolveRelativePath, NoInfer, CheckId, ToIdOption, Router, ValidFromPath, ToOptions, MatchRouteOptions, RouteInfoByPath, RouterOptions, Route, LinkOptions } from '@tanstack/router-core';
12
+ import { AnyRouteConfig, RouteConfig, AnyAllRouteInfo, AllRouteInfo, RouterState, RouteMatch, RouteInfo, DefaultAllRouteInfo, AnyRouteInfo, ResolveRelativePath, NoInfer, CheckId, ToIdOption, ValidFromPath, ToOptions, MatchRouteOptions, RouteInfoByPath, RegisteredAllRouteInfo, RegisteredRouter, RouterOptions, Router, Route, LinkOptions } from '@tanstack/router-core';
13
13
  export * from '@tanstack/router-core';
14
14
 
15
- interface RegisterRouter {
16
- }
17
- type RegisteredRouter = RegisterRouter extends {
18
- router: Router<infer TRouteConfig, infer TAllRouteInfo>;
19
- } ? Router<TRouteConfig, TAllRouteInfo> : Router;
20
- type RegisteredAllRouteInfo = RegisterRouter extends {
21
- router: Router<infer TRouteConfig, infer TAllRouteInfo>;
22
- } ? TAllRouteInfo : AnyAllRouteInfo;
23
15
  type SyncRouteComponent<TProps = {}> = (props: TProps) => JSX.Element | React.ReactNode;
24
16
  type RouteComponent<TProps = {}> = SyncRouteComponent<TProps> & {
25
17
  preload?: () => Promise<SyncRouteComponent<TProps>>;
@@ -50,8 +42,7 @@ declare module '@tanstack/router-core' {
50
42
  };
51
43
  }>;
52
44
  }
53
- interface RouterOptions<TRouteConfig extends AnyRouteConfig> {
54
- useContext?: () => RouterContext;
45
+ interface RouterOptions<TRouteConfig, TRouterContext> {
55
46
  }
56
47
  interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>> {
57
48
  useState: () => RouterState;
@@ -79,21 +70,21 @@ type PromptProps = {
79
70
  children?: React.ReactNode;
80
71
  };
81
72
  declare function Link<TTo extends string = '.'>(props: MakeLinkOptions<RegisteredAllRouteInfo, '/', TTo>): JSX.Element;
82
- declare const matchesContext: React.Context<RouteMatch<DefaultAllRouteInfo, RouteInfo<string, string, string, string, {}, {}, {}, {}, unknown, unknown, {}, {}, {}, {}, {}, {}>>[]>;
73
+ type MatchesContextValue = RouteMatch[];
74
+ declare const matchesContext: React.Context<MatchesContextValue>;
83
75
  declare const routerContext: React.Context<{
84
76
  router: RegisteredRouter;
85
77
  }>;
86
78
  type MatchesProviderProps = {
87
- value: RouteMatch[];
79
+ value: MatchesContextValue;
88
80
  children: React.ReactNode;
89
81
  };
90
82
  declare function MatchesProvider(props: MatchesProviderProps): JSX.Element;
91
- declare function createReactRouter<TRouteConfig extends AnyRouteConfig = RouteConfig>(opts: RouterOptions<TRouteConfig>): Router<TRouteConfig>;
92
- type RouterProps<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo> = RouterOptions<TRouteConfig> & {
93
- router: Router<TRouteConfig, TAllRouteInfo>;
94
- children?: React.ReactNode;
83
+ declare function createReactRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown>(opts: RouterOptions<TRouteConfig, TRouterContext>): Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
84
+ type RouterProps<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouterContext = unknown> = RouterOptions<TRouteConfig, TRouterContext> & {
85
+ router: Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
95
86
  };
96
- declare function RouterProvider<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo>({ children, router, ...rest }: RouterProps<TRouteConfig, TAllRouteInfo>): JSX.Element;
87
+ declare function RouterProvider<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouterContext = unknown>({ router, ...rest }: RouterProps<TRouteConfig, TAllRouteInfo, TRouterContext>): JSX.Element;
97
88
  declare function useRouter(): RegisteredRouter;
98
89
  declare function useMatches(): RouteMatch[];
99
90
  declare function useMatch<TId extends keyof RegisteredAllRouteInfo['routeInfoById'], TStrict extends boolean = true>(routeId: TId, opts?: {
@@ -111,4 +102,4 @@ declare function DefaultErrorBoundary({ error }: {
111
102
  declare function usePrompt(message: string, when: boolean | any): void;
112
103
  declare function Prompt({ message, when, children }: PromptProps): React.ReactNode;
113
104
 
114
- export { DefaultErrorBoundary, Link, MatchRoute, MatchesProvider, MatchesProviderProps, Outlet, Prompt, PromptProps, RegisterRouter, RegisteredAllRouteInfo, RegisteredRouter, RouteComponent, RouterProps, RouterProvider, SyncRouteComponent, createReactRouter, lazy, linkProps, matchesContext, routerContext, useMatch, useMatches, useNearestMatch, usePrompt, useRoute, useRouter, useSearch };
105
+ export { DefaultErrorBoundary, Link, MatchRoute, MatchesProvider, MatchesProviderProps, Outlet, Prompt, PromptProps, RouteComponent, RouterProps, RouterProvider, SyncRouteComponent, createReactRouter, lazy, linkProps, matchesContext, routerContext, useMatch, useMatches, useNearestMatch, usePrompt, useRoute, useRouter, useSearch };