@tanstack/react-router 0.0.1-beta.4 → 0.0.1-beta.41

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,66 +9,105 @@
9
9
  * @license MIT
10
10
  */
11
11
  import * as React from 'react';
12
- import { AnyRouteConfig, RouteConfig, AnyAllRouteInfo, AllRouteInfo, RouterState, RouteMatch, ToOptions, MatchRouteOptions, RouteInfoByPath, ResolveRelativePath, NoInfer, DefaultAllRouteInfo, AnyRouteInfo, RouteInfo, CheckId, ToIdOption, ValidFromPath, LinkOptions, RouterOptions, Router } from '@tanstack/router-core';
12
+ import { RegisteredAllRouteInfo, LinkOptions, ToOptions, MatchRouteOptions, RouteInfoByPath, ResolveRelativePath, NoInfer, ValidFromPath, RegisteredRouter, AnyRouteConfig, RouteConfig, AnyAllRouteInfo, AllRouteInfo, RouterOptions, Router, DefaultAllRouteInfo, RouterStore, RouteMatch, Route, Expand, Action } from '@tanstack/router-core';
13
13
  export * from '@tanstack/router-core';
14
+ export * from '@solidjs/reactivity';
14
15
 
16
+ type ReactNode = any;
17
+ type SyncRouteComponent<TProps = {}> = (props: TProps) => ReactNode;
18
+ type RouteComponent<TProps = {}> = SyncRouteComponent<TProps> & {
19
+ preload?: () => Promise<void>;
20
+ };
21
+ declare function lazy(importer: () => Promise<{
22
+ default: SyncRouteComponent;
23
+ }>): RouteComponent;
24
+ type LinkPropsOptions<TFrom extends RegisteredAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = LinkOptions<RegisteredAllRouteInfo, TFrom, TTo> & {
25
+ activeProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
26
+ inactiveProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
27
+ };
28
+ type MakeUseMatchRouteOptions<TFrom extends RegisteredAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = ToOptions<RegisteredAllRouteInfo, TFrom, TTo> & MatchRouteOptions;
29
+ type MakeMatchRouteOptions<TFrom extends RegisteredAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = ToOptions<RegisteredAllRouteInfo, TFrom, TTo> & MatchRouteOptions & {
30
+ children?: ReactNode | ((params: RouteInfoByPath<RegisteredAllRouteInfo, ResolveRelativePath<TFrom, NoInfer<TTo>>>['allParams']) => ReactNode);
31
+ };
32
+ type MakeLinkPropsOptions<TFrom extends ValidFromPath<RegisteredAllRouteInfo> = '/', TTo extends string = '.'> = LinkPropsOptions<TFrom, TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement>;
33
+ type MakeLinkOptions<TFrom extends RegisteredAllRouteInfo['routePaths'] = '/', TTo extends string = '.'> = LinkPropsOptions<TFrom, TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'children'> & {
34
+ children?: ReactNode | ((state: {
35
+ isActive: boolean;
36
+ }) => ReactNode);
37
+ };
15
38
  declare module '@tanstack/router-core' {
16
39
  interface FrameworkGenerics {
17
- Element: React.ReactNode;
18
- SyncOrAsyncElement: React.ReactNode | (() => Promise<any>);
40
+ Component: RouteComponent;
41
+ ErrorComponent: RouteComponent<{
42
+ error: unknown;
43
+ info: {
44
+ componentStack: string;
45
+ };
46
+ }>;
19
47
  }
20
- interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>> {
21
- useState: () => RouterState;
22
- useRoute: <TId extends keyof TAllRouteInfo['routeInfoById']>(routeId: TId) => Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TId]>;
23
- useMatch: <TId extends keyof TAllRouteInfo['routeInfoById']>(routeId: TId) => RouteMatch<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TId]>;
24
- linkProps: <TTo extends string = '.'>(props: LinkPropsOptions<TAllRouteInfo, '/', TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement>) => React.AnchorHTMLAttributes<HTMLAnchorElement>;
25
- Link: <TTo extends string = '.'>(props: LinkPropsOptions<TAllRouteInfo, '/', TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'children'> & {
26
- children?: React.ReactNode | ((state: {
27
- isActive: boolean;
28
- }) => React.ReactNode);
29
- }) => JSX.Element;
30
- MatchRoute: <TTo extends string = '.'>(props: ToOptions<TAllRouteInfo, '/', TTo> & MatchRouteOptions & {
31
- children?: React.ReactNode | ((params: RouteInfoByPath<TAllRouteInfo, ResolveRelativePath<'/', NoInfer<TTo>>>['allParams']) => React.ReactNode);
32
- }) => JSX.Element;
33
- }
34
- interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> {
35
- useRoute: <TTo extends string = '.', TResolved extends string = ResolveRelativePath<TRouteInfo['id'], NoInfer<TTo>>>(routeId: CheckId<TAllRouteInfo, TResolved, ToIdOption<TAllRouteInfo, TRouteInfo['id'], TTo>>) => Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TResolved]>;
36
- linkProps: <TTo extends string = '.'>(props: LinkPropsOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement>) => React.AnchorHTMLAttributes<HTMLAnchorElement>;
37
- Link: <TTo extends string = '.'>(props: LinkPropsOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'children'> & {
38
- children?: React.ReactNode | ((state: {
39
- isActive: boolean;
40
- }) => React.ReactNode);
41
- }) => JSX.Element;
42
- MatchRoute: <TTo extends string = '.'>(props: ToOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo> & MatchRouteOptions & {
43
- children?: React.ReactNode | ((params: RouteInfoByPath<TAllRouteInfo, ResolveRelativePath<TRouteInfo['fullPath'], NoInfer<TTo>>>['allParams']) => React.ReactNode);
44
- }) => JSX.Element;
48
+ interface RouterOptions<TRouteConfig, TRouterContext> {
45
49
  }
46
50
  }
47
- declare type LinkPropsOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = LinkOptions<TAllRouteInfo, TFrom, TTo> & {
48
- activeProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
49
- inactiveProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
50
- };
51
- declare type PromptProps = {
51
+ type PromptProps = {
52
52
  message: string;
53
53
  when?: boolean | any;
54
- children?: React.ReactNode;
54
+ children?: ReactNode;
55
55
  };
56
- declare type MatchesProviderProps = {
57
- value: RouteMatch[];
58
- children: React.ReactNode;
56
+ declare function useLinkProps<TFrom extends ValidFromPath<RegisteredAllRouteInfo> = '/', TTo extends string = '.'>(options: MakeLinkPropsOptions<TFrom, TTo>): React.AnchorHTMLAttributes<HTMLAnchorElement>;
57
+ interface LinkFn<TDefaultFrom extends RegisteredAllRouteInfo['routePaths'] = '/', TDefaultTo extends string = '.'> {
58
+ <TFrom extends RegisteredAllRouteInfo['routePaths'] = TDefaultFrom, TTo extends string = TDefaultTo>(props: MakeLinkOptions<TFrom, TTo>): ReactNode;
59
+ }
60
+ declare const Link: LinkFn;
61
+ type MatchesContextValue = RouteMatch[];
62
+ declare const matchesContext: React.Context<MatchesContextValue>;
63
+ declare const routerContext: React.Context<{
64
+ router: RegisteredRouter;
65
+ }>;
66
+ type MatchesProviderProps = {
67
+ value: MatchesContextValue;
68
+ children: ReactNode;
59
69
  };
60
- declare function MatchesProvider(props: MatchesProviderProps): JSX.Element;
61
- declare function createReactRouter<TRouteConfig extends AnyRouteConfig = RouteConfig>(opts: RouterOptions<TRouteConfig>): Router<TRouteConfig>;
62
- declare type RouterProps<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo> = RouterOptions<TRouteConfig> & {
63
- router: Router<TRouteConfig, TAllRouteInfo>;
64
- children?: React.ReactNode;
70
+ declare const __useStoreValue: <TSeed, TReturn>(seed: () => TSeed, selector?: ((seed: TSeed) => TReturn) | undefined) => TReturn;
71
+ declare function createReactRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown>(opts: RouterOptions<TRouteConfig, TRouterContext>): Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
72
+ type RouterProps<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouterContext = unknown> = RouterOptions<TRouteConfig, TRouterContext> & {
73
+ router: Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
65
74
  };
66
- declare function RouterProvider<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo>({ children, router, ...rest }: RouterProps<TRouteConfig, TAllRouteInfo>): JSX.Element;
75
+ declare function RouterProvider<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouterContext = unknown>({ router, ...rest }: RouterProps<TRouteConfig, TAllRouteInfo, TRouterContext>): JSX.Element;
76
+ declare function useRouter(): RegisteredRouter;
77
+ declare function useRouterStore<T = RouterStore>(selector?: (state: Router['store']) => T): T;
78
+ declare function useMatches(): RouteMatch[];
79
+ declare function useMatch<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'], TStrict extends boolean = true, TRouteMatch = RouteMatch<RegisteredAllRouteInfo, RegisteredAllRouteInfo['routeInfoById'][TFrom]>>(opts?: {
80
+ from: TFrom;
81
+ strict?: TStrict;
82
+ }): TStrict extends true ? TRouteMatch : TRouteMatch | undefined;
83
+ declare function useRoute<TId extends keyof RegisteredAllRouteInfo['routeInfoById'] = '/'>(routeId: TId): Route<RegisteredAllRouteInfo, RegisteredAllRouteInfo['routeInfoById'][TId]>;
84
+ declare function useLoaderData<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'] = '/', TStrict extends boolean = true, TLoaderData = RegisteredAllRouteInfo['routeInfoById'][TFrom]['loaderData'], TSelected = TLoaderData>(opts?: {
85
+ from: TFrom;
86
+ strict?: TStrict;
87
+ select?: (loaderData: TLoaderData) => TSelected;
88
+ }): TStrict extends true ? TSelected : TSelected | undefined;
89
+ declare function useSearch<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'], TStrict extends boolean = true, TSearch = RegisteredAllRouteInfo['routeInfoById'][TFrom]['fullSearchSchema'], TSelected = TSearch>(opts?: {
90
+ from: TFrom;
91
+ strict?: TStrict;
92
+ select?: (search: TSearch) => TSelected;
93
+ }): TStrict extends true ? TSelected : TSelected | undefined;
94
+ declare function useParams<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'] = '/', TDefaultSelected = Expand<RegisteredAllRouteInfo['allParams'] & RegisteredAllRouteInfo['routeInfoById'][TFrom]['allParams']>, TSelected = TDefaultSelected>(opts?: {
95
+ from: TFrom;
96
+ select?: (search: TDefaultSelected) => TSelected;
97
+ }): TSelected;
98
+ declare function useNavigate<TDefaultFrom extends keyof RegisteredAllRouteInfo['routeInfoById'] = '/'>(defaultOpts: {
99
+ from?: TDefaultFrom;
100
+ }): <TFrom extends string = TDefaultFrom, TTo extends string = ".">(opts: MakeLinkOptions<TFrom, TTo>) => Promise<void>;
101
+ declare function useAction<TFrom extends keyof RegisteredAllRouteInfo['routeInfoById'] = '/', TFromRoute extends RegisteredAllRouteInfo['routeInfoById'][TFrom] = RegisteredAllRouteInfo['routeInfoById'][TFrom]>(opts: {
102
+ from: TFrom;
103
+ }): Action<TFromRoute['actionPayload'], TFromRoute['actionResponse']>;
104
+ declare function useMatchRoute(): <TFrom extends ValidFromPath<AnyAllRouteInfo> = "/", TTo extends string = ".">(opts: MakeUseMatchRouteOptions<TFrom, TTo>) => false;
105
+ declare function MatchRoute<TFrom extends ValidFromPath<RegisteredAllRouteInfo> = '/', TTo extends string = '.'>(props: MakeMatchRouteOptions<TFrom, TTo>): any;
67
106
  declare function Outlet(): JSX.Element | null;
68
107
  declare function DefaultErrorBoundary({ error }: {
69
108
  error: any;
70
109
  }): JSX.Element;
71
110
  declare function usePrompt(message: string, when: boolean | any): void;
72
- declare function Prompt({ message, when, children }: PromptProps): React.ReactNode;
111
+ declare function Prompt({ message, when, children }: PromptProps): any;
73
112
 
74
- export { DefaultErrorBoundary, MatchesProvider, MatchesProviderProps, Outlet, Prompt, PromptProps, RouterProps, RouterProvider, createReactRouter, usePrompt };
113
+ export { DefaultErrorBoundary, Link, LinkFn, LinkPropsOptions, MakeLinkOptions, MakeLinkPropsOptions, MakeMatchRouteOptions, MakeUseMatchRouteOptions, MatchRoute, MatchesProviderProps, Outlet, Prompt, PromptProps, RouteComponent, RouterProps, RouterProvider, SyncRouteComponent, __useStoreValue, createReactRouter, lazy, matchesContext, routerContext, useAction, useLinkProps, useLoaderData, useMatch, useMatchRoute, useMatches, useNavigate, useParams, usePrompt, useRoute, useRouter, useRouterStore, useSearch };