router-kit 0.2.0 → 0.2.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.
- package/dist/hooks/useRouter.js +34 -2
- package/package.json +1 -1
package/dist/hooks/useRouter.js
CHANGED
|
@@ -1,8 +1,40 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Router-Kit — Common hooks and components (reference)
|
|
3
|
+
|
|
4
|
+
Hooks:
|
|
5
|
+
- useRouter : access router context and helpers
|
|
6
|
+
- useLocation : current location (pathname, search, hash)
|
|
7
|
+
- useNavigate : imperative navigation function
|
|
8
|
+
- useParams : route params for the current route
|
|
9
|
+
- useSearchParams : read/update URL query params
|
|
10
|
+
- useRouteMatch : match the current location against a pattern
|
|
11
|
+
- useBlocker/usePrompt : block navigation with a confirmation
|
|
12
|
+
|
|
13
|
+
Components / APIs:
|
|
14
|
+
- createRouter : factory to create a router instance and Provider
|
|
15
|
+
- RouterProvider : provider component returned by createRouter()
|
|
16
|
+
- Routes : route collection wrapper
|
|
17
|
+
- Route : single route declaration
|
|
18
|
+
- Link : declarative link component
|
|
19
|
+
- NavLink : link with active styling
|
|
20
|
+
- Outlet : render child route content
|
|
21
|
+
- Redirect : declarative redirect helper (if provided)
|
|
22
|
+
|
|
23
|
+
Note: Exact names may vary between versions — update this list to match your installed Router-Kit exports.
|
|
24
|
+
*/
|
|
1
25
|
import { useContext } from "react";
|
|
2
26
|
import RouterContext from "../context/RouterContext";
|
|
3
27
|
export function useRouter() {
|
|
4
28
|
const ctx = useContext(RouterContext);
|
|
5
|
-
if (!ctx)
|
|
6
|
-
|
|
29
|
+
if (!ctx) {
|
|
30
|
+
const message = "Common hooks and components must be used within the RouterProvider returned by createRouter(). Wrap your app with the RouterProvider.";
|
|
31
|
+
if (typeof window !== "undefined" && window.console && console.error) {
|
|
32
|
+
console.error("%cRouterKit%c " + message, "color: #fff; background: #d9534f; font-weight: 700; padding: 2px 6px; border-radius: 3px;", "color: #d9534f;");
|
|
33
|
+
}
|
|
34
|
+
else {
|
|
35
|
+
console.error("RouterKit: " + message);
|
|
36
|
+
}
|
|
37
|
+
throw new Error("RouterKit: " + message);
|
|
38
|
+
}
|
|
7
39
|
return ctx;
|
|
8
40
|
}
|
package/package.json
CHANGED