@real-router/react 0.4.1 → 0.4.3

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 (2) hide show
  1. package/README.md +16 -6
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -30,8 +30,11 @@ import { createRoot } from "react-dom/client";
30
30
  // Define routes
31
31
  const routes = [
32
32
  { name: "home", path: "/" },
33
- { name: "users", path: "/users" },
34
- { name: "users.profile", path: "/:id" },
33
+ {
34
+ name: "users",
35
+ path: "/users",
36
+ children: [{ name: "profile", path: "/:id" }],
37
+ },
35
38
  ];
36
39
 
37
40
  // Create and configure router
@@ -70,6 +73,7 @@ createRoot(document.getElementById("root")!).render(
70
73
  ### Provider
71
74
 
72
75
  #### `<RouterProvider router={router}>`
76
+
73
77
  Provides router instance to component tree via React Context.\
74
78
  `router: Router` — router instance from `createRouter()`\
75
79
  `children: ReactNode` — child components\
@@ -86,6 +90,7 @@ Provides router instance to component tree via React Context.\
86
90
  ### Hooks
87
91
 
88
92
  #### `useRouter(): Router`
93
+
89
94
  Get router instance. **Never re-renders** on navigation.\
90
95
  Returns: `Router` — router instance\
91
96
  [Wiki](https://github.com/greydragon888/real-router/wiki/useRouter)
@@ -97,10 +102,11 @@ const NavigateButton = () => {
97
102
  const router = useRouter();
98
103
 
99
104
  return <button onClick={() => router.navigate("home")}>Go Home</button>;
100
- }
105
+ };
101
106
  ```
102
107
 
103
108
  #### `useRoute(): { router, route, previousRoute }`
109
+
104
110
  Get current route state. **Re-renders on every navigation.**\
105
111
  Returns: `{ router: Router, route: State | undefined, previousRoute: State | undefined }`\
106
112
  [Wiki](https://github.com/greydragon888/real-router/wiki/useRoute)
@@ -119,10 +125,11 @@ const CurrentRoute = () => {
119
125
  <button onClick={() => router.navigate("home")}>Go Home</button>
120
126
  </div>
121
127
  );
122
- }
128
+ };
123
129
  ```
124
130
 
125
131
  #### `useRouteNode(nodeName: string): { router, route, previousRoute }`
132
+
126
133
  Optimized hook for nested routes. **Re-renders only when specified node changes.**\
127
134
  `nodeName: string` — route segment to observe (e.g., `"users"`)
128
135
  Returns: `{ router: Router, route: State | undefined, previousRoute: State | undefined }`\
@@ -148,7 +155,7 @@ const UsersSection = () => {
148
155
  default:
149
156
  return null;
150
157
  }
151
- }
158
+ };
152
159
  ```
153
160
 
154
161
  ---
@@ -156,6 +163,7 @@ const UsersSection = () => {
156
163
  ### Components
157
164
 
158
165
  #### `<Link routeName={string} routeParams={object} ...props>`
166
+
159
167
  Navigation link with automatic active state detection.\
160
168
  `routeName: string` — target route name\
161
169
  `routeParams?: Params` — route parameters\
@@ -175,15 +183,17 @@ import { Link } from "@real-router/react";
175
183
  activeStrict={false}
176
184
  >
177
185
  View Profile
178
- </Link>
186
+ </Link>;
179
187
  ```
180
188
 
181
189
  #### `<ConnectedLink ...props>`
190
+
182
191
  Same as `Link`, but re-renders on every route change.\
183
192
  Props: same as `Link`\
184
193
  [Wiki](https://github.com/greydragon888/real-router/wiki/ConnectedLink)
185
194
 
186
195
  #### `<BaseLink router={router} ...props>`
196
+
187
197
  Low-level link component. Requires router instance as prop.\
188
198
  `router: Router` — router instance\
189
199
  Props: same as `Link`\
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@real-router/react",
3
- "version": "0.4.1",
3
+ "version": "0.4.3",
4
4
  "type": "commonjs",
5
5
  "description": "React integration for Real-Router",
6
6
  "main": "./dist/cjs/index.js",
@@ -46,8 +46,8 @@
46
46
  "license": "MIT",
47
47
  "sideEffects": false,
48
48
  "dependencies": {
49
- "@real-router/core": "^0.19.0",
50
- "@real-router/helpers": "^0.1.22"
49
+ "@real-router/core": "^0.21.0",
50
+ "@real-router/helpers": "^0.1.24"
51
51
  },
52
52
  "devDependencies": {
53
53
  "@testing-library/dom": "10.4.1",
@@ -61,7 +61,7 @@
61
61
  "@types/react-dom": ">=18.0.0",
62
62
  "react": ">=18.0.0",
63
63
  "react-dom": ">=18.0.0",
64
- "@real-router/browser-plugin": "^0.3.1"
64
+ "@real-router/browser-plugin": "^0.3.3"
65
65
  },
66
66
  "scripts": {
67
67
  "build": "tsup",