@real-router/solid 0.0.1

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.
Files changed (73) hide show
  1. package/README.md +313 -0
  2. package/dist/cjs/index.d.ts +103 -0
  3. package/dist/cjs/index.js +351 -0
  4. package/dist/esm/index.d.mts +103 -0
  5. package/dist/esm/index.mjs +334 -0
  6. package/dist/types/RouterProvider.d.ts +8 -0
  7. package/dist/types/RouterProvider.d.ts.map +1 -0
  8. package/dist/types/components/Link.d.ts +5 -0
  9. package/dist/types/components/Link.d.ts.map +1 -0
  10. package/dist/types/components/RouteView/RouteView.d.ts +13 -0
  11. package/dist/types/components/RouteView/RouteView.d.ts.map +1 -0
  12. package/dist/types/components/RouteView/components.d.ts +25 -0
  13. package/dist/types/components/RouteView/components.d.ts.map +1 -0
  14. package/dist/types/components/RouteView/helpers.d.ts +8 -0
  15. package/dist/types/components/RouteView/helpers.d.ts.map +1 -0
  16. package/dist/types/components/RouteView/index.d.ts +3 -0
  17. package/dist/types/components/RouteView/index.d.ts.map +1 -0
  18. package/dist/types/components/RouteView/types.d.ts +15 -0
  19. package/dist/types/components/RouteView/types.d.ts.map +1 -0
  20. package/dist/types/constants.d.ts +9 -0
  21. package/dist/types/constants.d.ts.map +1 -0
  22. package/dist/types/context.d.ts +11 -0
  23. package/dist/types/context.d.ts.map +1 -0
  24. package/dist/types/createSignalFromSource.d.ts +4 -0
  25. package/dist/types/createSignalFromSource.d.ts.map +1 -0
  26. package/dist/types/createStoreFromSource.d.ts +3 -0
  27. package/dist/types/createStoreFromSource.d.ts.map +1 -0
  28. package/dist/types/directives/link.d.ts +11 -0
  29. package/dist/types/directives/link.d.ts.map +1 -0
  30. package/dist/types/hooks/useNavigator.d.ts +3 -0
  31. package/dist/types/hooks/useNavigator.d.ts.map +1 -0
  32. package/dist/types/hooks/useRoute.d.ts +4 -0
  33. package/dist/types/hooks/useRoute.d.ts.map +1 -0
  34. package/dist/types/hooks/useRouteNode.d.ts +4 -0
  35. package/dist/types/hooks/useRouteNode.d.ts.map +1 -0
  36. package/dist/types/hooks/useRouteNodeStore.d.ts +3 -0
  37. package/dist/types/hooks/useRouteNodeStore.d.ts.map +1 -0
  38. package/dist/types/hooks/useRouteStore.d.ts +3 -0
  39. package/dist/types/hooks/useRouteStore.d.ts.map +1 -0
  40. package/dist/types/hooks/useRouteUtils.d.ts +3 -0
  41. package/dist/types/hooks/useRouteUtils.d.ts.map +1 -0
  42. package/dist/types/hooks/useRouter.d.ts +3 -0
  43. package/dist/types/hooks/useRouter.d.ts.map +1 -0
  44. package/dist/types/hooks/useRouterTransition.d.ts +4 -0
  45. package/dist/types/hooks/useRouterTransition.d.ts.map +1 -0
  46. package/dist/types/index.d.ts +21 -0
  47. package/dist/types/index.d.ts.map +1 -0
  48. package/dist/types/types.d.ts +17 -0
  49. package/dist/types/types.d.ts.map +1 -0
  50. package/package.json +89 -0
  51. package/src/RouterProvider.tsx +60 -0
  52. package/src/components/Link.tsx +91 -0
  53. package/src/components/RouteView/RouteView.tsx +53 -0
  54. package/src/components/RouteView/components.tsx +50 -0
  55. package/src/components/RouteView/helpers.tsx +108 -0
  56. package/src/components/RouteView/index.ts +7 -0
  57. package/src/components/RouteView/types.ts +17 -0
  58. package/src/constants.ts +9 -0
  59. package/src/context.ts +15 -0
  60. package/src/createSignalFromSource.ts +20 -0
  61. package/src/createStoreFromSource.ts +20 -0
  62. package/src/directives/link.tsx +79 -0
  63. package/src/directives.d.ts +10 -0
  64. package/src/hooks/useNavigator.tsx +15 -0
  65. package/src/hooks/useRoute.tsx +16 -0
  66. package/src/hooks/useRouteNode.tsx +14 -0
  67. package/src/hooks/useRouteNodeStore.tsx +12 -0
  68. package/src/hooks/useRouteStore.tsx +20 -0
  69. package/src/hooks/useRouteUtils.tsx +12 -0
  70. package/src/hooks/useRouter.tsx +15 -0
  71. package/src/hooks/useRouterTransition.tsx +14 -0
  72. package/src/index.tsx +43 -0
  73. package/src/types.ts +24 -0
@@ -0,0 +1,12 @@
1
+ import { createRouteNodeSource } from "@real-router/sources";
2
+
3
+ import { createStoreFromSource } from "../createStoreFromSource";
4
+ import { useRouter } from "./useRouter";
5
+
6
+ import type { RouteState } from "../types";
7
+
8
+ export function useRouteNodeStore(nodeName: string): RouteState {
9
+ const router = useRouter();
10
+
11
+ return createStoreFromSource(createRouteNodeSource(router, nodeName));
12
+ }
@@ -0,0 +1,20 @@
1
+ import { createRouteSource } from "@real-router/sources";
2
+ import { useContext } from "solid-js";
3
+
4
+ import { RouteContext } from "../context";
5
+ import { createStoreFromSource } from "../createStoreFromSource";
6
+ import { useRouter } from "./useRouter";
7
+
8
+ import type { RouteState } from "../types";
9
+
10
+ export function useRouteStore(): RouteState {
11
+ const ctx = useContext(RouteContext);
12
+
13
+ if (!ctx) {
14
+ throw new Error("useRouteStore must be used within a RouterProvider");
15
+ }
16
+
17
+ const router = useRouter();
18
+
19
+ return createStoreFromSource(createRouteSource(router));
20
+ }
@@ -0,0 +1,12 @@
1
+ import { getPluginApi } from "@real-router/core/api";
2
+ import { getRouteUtils } from "@real-router/route-utils";
3
+
4
+ import { useRouter } from "./useRouter";
5
+
6
+ import type { RouteUtils } from "@real-router/route-utils";
7
+
8
+ export const useRouteUtils = (): RouteUtils => {
9
+ const router = useRouter();
10
+
11
+ return getRouteUtils(getPluginApi(router).getTree());
12
+ };
@@ -0,0 +1,15 @@
1
+ import { useContext } from "solid-js";
2
+
3
+ import { RouterContext } from "../context";
4
+
5
+ import type { Router } from "@real-router/core";
6
+
7
+ export const useRouter = (): Router => {
8
+ const ctx = useContext(RouterContext);
9
+
10
+ if (!ctx) {
11
+ throw new Error("useRouter must be used within a RouterProvider");
12
+ }
13
+
14
+ return ctx.router;
15
+ };
@@ -0,0 +1,14 @@
1
+ import { createTransitionSource } from "@real-router/sources";
2
+
3
+ import { createSignalFromSource } from "../createSignalFromSource";
4
+ import { useRouter } from "./useRouter";
5
+
6
+ import type { RouterTransitionSnapshot } from "@real-router/sources";
7
+ import type { Accessor } from "solid-js";
8
+
9
+ export function useRouterTransition(): Accessor<RouterTransitionSnapshot> {
10
+ const router = useRouter();
11
+ const store = createTransitionSource(router);
12
+
13
+ return createSignalFromSource(store);
14
+ }
package/src/index.tsx ADDED
@@ -0,0 +1,43 @@
1
+ export { RouteView } from "./components/RouteView";
2
+
3
+ export { Link } from "./components/Link";
4
+
5
+ export { link } from "./directives/link";
6
+
7
+ export { useRouter } from "./hooks/useRouter";
8
+
9
+ export { useNavigator } from "./hooks/useNavigator";
10
+
11
+ export { useRouteUtils } from "./hooks/useRouteUtils";
12
+
13
+ export { useRoute } from "./hooks/useRoute";
14
+
15
+ export { useRouteNode } from "./hooks/useRouteNode";
16
+
17
+ export { useRouteStore } from "./hooks/useRouteStore";
18
+
19
+ export { useRouteNodeStore } from "./hooks/useRouteNodeStore";
20
+
21
+ export { useRouterTransition } from "./hooks/useRouterTransition";
22
+
23
+ export { RouterProvider } from "./RouterProvider";
24
+
25
+ export { RouterContext, RouteContext } from "./context";
26
+
27
+ export { createSignalFromSource } from "./createSignalFromSource";
28
+
29
+ export { createStoreFromSource } from "./createStoreFromSource";
30
+
31
+ export type { LinkProps, RouteState } from "./types";
32
+
33
+ export type { LinkDirectiveOptions } from "./directives/link";
34
+
35
+ export type {
36
+ RouteViewProps,
37
+ RouteViewMatchProps,
38
+ RouteViewNotFoundProps,
39
+ } from "./components/RouteView";
40
+
41
+ export type { Navigator } from "@real-router/core";
42
+
43
+ export type { RouterTransitionSnapshot } from "@real-router/sources";
package/src/types.ts ADDED
@@ -0,0 +1,24 @@
1
+ import type { NavigationOptions, Params, State } from "@real-router/core";
2
+ import type { JSX } from "solid-js";
3
+
4
+ export interface RouteState<
5
+ P extends Params = Params,
6
+ MP extends Params = Params,
7
+ > {
8
+ route: State<P, MP> | undefined;
9
+ previousRoute?: State | undefined;
10
+ }
11
+
12
+ export interface LinkProps<P extends Params = Params> extends Omit<
13
+ JSX.HTMLAttributes<HTMLAnchorElement>,
14
+ "onClick"
15
+ > {
16
+ routeName: string;
17
+ routeParams?: P;
18
+ routeOptions?: NavigationOptions;
19
+ activeClassName?: string;
20
+ activeStrict?: boolean;
21
+ ignoreQueryParams?: boolean;
22
+ target?: string;
23
+ onClick?: (evt: MouseEvent) => void;
24
+ }