@molecule/app-routing-react-router 1.2.1 → 1.2.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.
- package/README.md +49 -15
- package/dist/hooks.d.ts +20 -6
- package/dist/hooks.d.ts.map +1 -1
- package/dist/hooks.js +31 -11
- package/dist/hooks.js.map +1 -1
- package/dist/index.d.ts +10 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +10 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
|
|
|
3
3
|
Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
|
|
4
4
|
Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
|
|
5
5
|
To change this document, edit the module-level JSDoc in src/index.ts.
|
|
6
|
-
Generated: 2026-11-
|
|
6
|
+
Generated: 2026-11-08T06:10:19.355Z
|
|
7
7
|
-->
|
|
8
8
|
|
|
9
9
|
# @molecule/app-routing-react-router
|
|
@@ -13,6 +13,14 @@ React Router (v7/v8) provider for `@molecule/app-routing`.
|
|
|
13
13
|
This package provides a React Router implementation of the molecule Router interface,
|
|
14
14
|
allowing you to use molecule's routing abstractions with React Router.
|
|
15
15
|
|
|
16
|
+
`useMoleculeRouter`, `useMoleculeQuery`, `useMoleculeNavigate`, and `useIsActive`
|
|
17
|
+
work inside any React Router router (BrowserRouter, HashRouter, MemoryRouter,
|
|
18
|
+
Router, or RouterProvider), from this package or React Router itself. No
|
|
19
|
+
MoleculeRouterProvider is required for these hooks. Mount MoleculeRouterProvider
|
|
20
|
+
only to bond the adapter for non-React `@molecule/app-routing` navigate()/getRouter(),
|
|
21
|
+
supply named routes, or receive onRouterReady. Hook-created adapters remain local
|
|
22
|
+
so multiple consumers cannot overwrite the global router bond.
|
|
23
|
+
|
|
16
24
|
**Paginated or filtered page? Use `useListRoute` for its URL state.** It reads
|
|
17
25
|
page, filters and selected views from the current URL; builds links that retain
|
|
18
26
|
the current path/filters; and resets page when a filter or view changes. Declare
|
|
@@ -30,6 +38,7 @@ import { Routes, Route } from 'react-router'
|
|
|
30
38
|
import { BrowserRouter, MoleculeRouterProvider } from '@molecule/app-routing-react-router'
|
|
31
39
|
|
|
32
40
|
function App() {
|
|
41
|
+
// Optional: include this provider for non-React navigation or named routes.
|
|
33
42
|
// MoleculeRouterProvider bonds the adapter automatically (calls setRouter in an
|
|
34
43
|
// effect on mount), so @molecule/app-routing's navigate()/getRouter() drive THIS
|
|
35
44
|
// real React Router — no manual setRouter wiring needed.
|
|
@@ -403,18 +412,22 @@ interface RouteLocation {
|
|
|
403
412
|
* Current pathname.
|
|
404
413
|
*/
|
|
405
414
|
pathname: string
|
|
415
|
+
|
|
406
416
|
/**
|
|
407
417
|
* Query string (including leading ?).
|
|
408
418
|
*/
|
|
409
419
|
search: string
|
|
420
|
+
|
|
410
421
|
/**
|
|
411
422
|
* Hash (including leading #).
|
|
412
423
|
*/
|
|
413
424
|
hash: string
|
|
425
|
+
|
|
414
426
|
/**
|
|
415
427
|
* State data passed with navigation.
|
|
416
428
|
*/
|
|
417
429
|
state?: unknown
|
|
430
|
+
|
|
418
431
|
/**
|
|
419
432
|
* Unique key for this location.
|
|
420
433
|
*/
|
|
@@ -432,14 +445,17 @@ interface RouteMatch<Params extends RouteParams = RouteParams> {
|
|
|
432
445
|
* Route path pattern.
|
|
433
446
|
*/
|
|
434
447
|
path: string
|
|
448
|
+
|
|
435
449
|
/**
|
|
436
450
|
* Matched URL pathname.
|
|
437
451
|
*/
|
|
438
452
|
pathname: string
|
|
453
|
+
|
|
439
454
|
/**
|
|
440
455
|
* Route parameters.
|
|
441
456
|
*/
|
|
442
457
|
params: Params
|
|
458
|
+
|
|
443
459
|
/**
|
|
444
460
|
* Whether this is an exact match.
|
|
445
461
|
*/
|
|
@@ -457,14 +473,17 @@ interface NavigateOptions {
|
|
|
457
473
|
* Replace current history entry instead of pushing.
|
|
458
474
|
*/
|
|
459
475
|
replace?: boolean
|
|
476
|
+
|
|
460
477
|
/**
|
|
461
478
|
* State to pass with navigation.
|
|
462
479
|
*/
|
|
463
480
|
state?: unknown
|
|
481
|
+
|
|
464
482
|
/**
|
|
465
483
|
* Preserve current query params.
|
|
466
484
|
*/
|
|
467
485
|
preserveQuery?: boolean
|
|
486
|
+
|
|
468
487
|
/**
|
|
469
488
|
* Preserve current hash.
|
|
470
489
|
*/
|
|
@@ -482,26 +501,32 @@ interface RouteDefinition {
|
|
|
482
501
|
* Route path pattern.
|
|
483
502
|
*/
|
|
484
503
|
path: string
|
|
504
|
+
|
|
485
505
|
/**
|
|
486
506
|
* Route name (for named routes).
|
|
487
507
|
*/
|
|
488
508
|
name?: string
|
|
509
|
+
|
|
489
510
|
/**
|
|
490
511
|
* Whether the route requires exact matching.
|
|
491
512
|
*/
|
|
492
513
|
exact?: boolean
|
|
514
|
+
|
|
493
515
|
/**
|
|
494
516
|
* Whether the route requires authentication.
|
|
495
517
|
*/
|
|
496
518
|
requiresAuth?: boolean
|
|
519
|
+
|
|
497
520
|
/**
|
|
498
521
|
* Required roles/permissions.
|
|
499
522
|
*/
|
|
500
523
|
roles?: string[]
|
|
524
|
+
|
|
501
525
|
/**
|
|
502
526
|
* Route metadata.
|
|
503
527
|
*/
|
|
504
528
|
meta?: Record<string, unknown>
|
|
529
|
+
|
|
505
530
|
/**
|
|
506
531
|
* Child routes.
|
|
507
532
|
*/
|
|
@@ -519,10 +544,12 @@ interface RouterConfig {
|
|
|
519
544
|
* Router mode.
|
|
520
545
|
*/
|
|
521
546
|
mode?: 'history' | 'hash' | 'memory'
|
|
547
|
+
|
|
522
548
|
/**
|
|
523
549
|
* Base path.
|
|
524
550
|
*/
|
|
525
551
|
basePath?: string
|
|
552
|
+
|
|
526
553
|
/**
|
|
527
554
|
* Initial routes.
|
|
528
555
|
*/
|
|
@@ -609,14 +636,7 @@ type QueryParams = Record<string, string | string[] | undefined>
|
|
|
609
636
|
Navigation guard result.
|
|
610
637
|
|
|
611
638
|
```typescript
|
|
612
|
-
type GuardResult =
|
|
613
|
-
| boolean
|
|
614
|
-
| string
|
|
615
|
-
| {
|
|
616
|
-
path: string
|
|
617
|
-
replace?: boolean
|
|
618
|
-
}
|
|
619
|
-
| void
|
|
639
|
+
type GuardResult = boolean | string | { path: string; replace?: boolean } | void
|
|
620
640
|
```
|
|
621
641
|
|
|
622
642
|
#### `NavigationGuard`
|
|
@@ -653,7 +673,8 @@ bonds it as the active singleton via `@molecule/app-routing`'s `setRouter`.
|
|
|
653
673
|
Bonding happens in an effect on mount (and again whenever the location/params
|
|
654
674
|
change), so `@molecule/app-routing`'s `navigate()`/`getRouter()` drive THIS real
|
|
655
675
|
React Router adapter — no manual `setRouter` wiring required. Mount it once inside
|
|
656
|
-
|
|
676
|
+
any React Router router when non-React code needs the bond, named routes are
|
|
677
|
+
configured, or `onRouterReady` is needed. The routing hooks work without this provider.
|
|
657
678
|
|
|
658
679
|
```typescript
|
|
659
680
|
function MoleculeRouterProvider(props: MoleculeRouterProviderProps): React.JSX.Element
|
|
@@ -665,7 +686,14 @@ function MoleculeRouterProvider(props: MoleculeRouterProviderProps): React.JSX.E
|
|
|
665
686
|
|
|
666
687
|
#### `useMoleculeRouter()`
|
|
667
688
|
|
|
668
|
-
Hook to get the molecule Router
|
|
689
|
+
Hook to get the molecule Router inside any React Router router, including
|
|
690
|
+
BrowserRouter, HashRouter, MemoryRouter, Router, or RouterProvider from this
|
|
691
|
+
package or React Router itself. No MoleculeRouterProvider is required.
|
|
692
|
+
|
|
693
|
+
When MoleculeRouterProvider is mounted, returns its exact router with its named
|
|
694
|
+
routes. Otherwise creates a local adapter from React Router's hooks without
|
|
695
|
+
bonding it globally. Mount MoleculeRouterProvider for the non-React
|
|
696
|
+
`@molecule/app-routing` navigate()/getRouter() bond or onRouterReady.
|
|
669
697
|
|
|
670
698
|
```typescript
|
|
671
699
|
function useMoleculeRouter(): Router
|
|
@@ -675,7 +703,9 @@ function useMoleculeRouter(): Router
|
|
|
675
703
|
|
|
676
704
|
#### `useIsActive(path, exact)`
|
|
677
705
|
|
|
678
|
-
Hook to check if a path is currently active.
|
|
706
|
+
Hook to check if a path is currently active inside any React Router router.
|
|
707
|
+
MoleculeRouterProvider is optional; mount it only for named routes, the
|
|
708
|
+
non-React navigate()/getRouter() bond, or onRouterReady.
|
|
679
709
|
|
|
680
710
|
```typescript
|
|
681
711
|
function useIsActive(path: string, exact?: boolean): boolean
|
|
@@ -688,7 +718,9 @@ function useIsActive(path: string, exact?: boolean): boolean
|
|
|
688
718
|
|
|
689
719
|
#### `useMoleculeNavigate()`
|
|
690
720
|
|
|
691
|
-
Hook to get a navigate function with molecule Router options
|
|
721
|
+
Hook to get a navigate function with molecule Router options inside any React
|
|
722
|
+
Router router. MoleculeRouterProvider is optional; mount it only for named
|
|
723
|
+
routes, the non-React navigate()/getRouter() bond, or onRouterReady.
|
|
692
724
|
|
|
693
725
|
```typescript
|
|
694
726
|
function useMoleculeNavigate(): Router['navigate']
|
|
@@ -698,7 +730,9 @@ function useMoleculeNavigate(): Router['navigate']
|
|
|
698
730
|
|
|
699
731
|
#### `useMoleculeQuery()`
|
|
700
732
|
|
|
701
|
-
Hook to get current query params as an object.
|
|
733
|
+
Hook to get current query params as an object inside any React Router router.
|
|
734
|
+
MoleculeRouterProvider is optional; mount it only for named routes, the
|
|
735
|
+
non-React navigate()/getRouter() bond, or onRouterReady.
|
|
702
736
|
|
|
703
737
|
```typescript
|
|
704
738
|
function useMoleculeQuery(): QueryParams
|
|
@@ -986,7 +1020,7 @@ Peer dependencies:
|
|
|
986
1020
|
- **Do NOT wire the exported `provider` const** in a React Router app — it is a
|
|
987
1021
|
no-hooks fallback (empty params, `window.location.href` navigation). Use
|
|
988
1022
|
`MoleculeRouterProvider` (or `createReactRouter` with hook values) instead.
|
|
989
|
-
- The provider must live INSIDE
|
|
1023
|
+
- The provider must live INSIDE a React Router router (it calls React Router hooks).
|
|
990
1024
|
- **Import router components from this bond, never directly from React Router.**
|
|
991
1025
|
Its wrappers turn transitions off, so a navigation renders the new route in the
|
|
992
1026
|
same commit as the URL change. Import non-router APIs (`Routes`, `Route`, `Link`,
|
package/dist/hooks.d.ts
CHANGED
|
@@ -29,7 +29,8 @@ export interface MoleculeRouterProviderProps {
|
|
|
29
29
|
* Bonding happens in an effect on mount (and again whenever the location/params
|
|
30
30
|
* change), so `@molecule/app-routing`'s `navigate()`/`getRouter()` drive THIS real
|
|
31
31
|
* React Router adapter — no manual `setRouter` wiring required. Mount it once inside
|
|
32
|
-
*
|
|
32
|
+
* any React Router router when non-React code needs the bond, named routes are
|
|
33
|
+
* configured, or `onRouterReady` is needed. The routing hooks work without this provider.
|
|
33
34
|
*
|
|
34
35
|
* @param props - The provider props (see {@link MoleculeRouterProviderProps}):
|
|
35
36
|
* `children` (rendered inside the router context), `routes` (optional named-route
|
|
@@ -59,10 +60,17 @@ export interface MoleculeRouterProviderProps {
|
|
|
59
60
|
*/
|
|
60
61
|
export declare function MoleculeRouterProvider(props: MoleculeRouterProviderProps): React.JSX.Element;
|
|
61
62
|
/**
|
|
62
|
-
* Hook to get the molecule Router
|
|
63
|
+
* Hook to get the molecule Router inside any React Router router, including
|
|
64
|
+
* BrowserRouter, HashRouter, MemoryRouter, Router, or RouterProvider from this
|
|
65
|
+
* package or React Router itself. No MoleculeRouterProvider is required.
|
|
66
|
+
*
|
|
67
|
+
* When MoleculeRouterProvider is mounted, returns its exact router with its named
|
|
68
|
+
* routes. Otherwise creates a local adapter from React Router's hooks without
|
|
69
|
+
* bonding it globally. Mount MoleculeRouterProvider for the non-React
|
|
70
|
+
* `@molecule/app-routing` navigate()/getRouter() bond or onRouterReady.
|
|
63
71
|
*
|
|
64
72
|
* @returns The molecule Router instance
|
|
65
|
-
* @throws {Error} If used outside
|
|
73
|
+
* @throws {Error} If used outside a React Router router; mount a router component.
|
|
66
74
|
*
|
|
67
75
|
* @example
|
|
68
76
|
* ```tsx
|
|
@@ -79,7 +87,9 @@ export declare function MoleculeRouterProvider(props: MoleculeRouterProviderProp
|
|
|
79
87
|
*/
|
|
80
88
|
export declare function useMoleculeRouter(): Router;
|
|
81
89
|
/**
|
|
82
|
-
* Hook to check if a path is currently active.
|
|
90
|
+
* Hook to check if a path is currently active inside any React Router router.
|
|
91
|
+
* MoleculeRouterProvider is optional; mount it only for named routes, the
|
|
92
|
+
* non-React navigate()/getRouter() bond, or onRouterReady.
|
|
83
93
|
*
|
|
84
94
|
* @param path - Path to check
|
|
85
95
|
* @param exact - Whether to require exact match
|
|
@@ -99,7 +109,9 @@ export declare function useMoleculeRouter(): Router;
|
|
|
99
109
|
*/
|
|
100
110
|
export declare function useIsActive(path: string, exact?: boolean): boolean;
|
|
101
111
|
/**
|
|
102
|
-
* Hook to get a navigate function with molecule Router options
|
|
112
|
+
* Hook to get a navigate function with molecule Router options inside any React
|
|
113
|
+
* Router router. MoleculeRouterProvider is optional; mount it only for named
|
|
114
|
+
* routes, the non-React navigate()/getRouter() bond, or onRouterReady.
|
|
103
115
|
*
|
|
104
116
|
* @returns Navigate function
|
|
105
117
|
*
|
|
@@ -117,7 +129,9 @@ export declare function useIsActive(path: string, exact?: boolean): boolean;
|
|
|
117
129
|
*/
|
|
118
130
|
export declare function useMoleculeNavigate(): Router['navigate'];
|
|
119
131
|
/**
|
|
120
|
-
* Hook to get current query params as an object.
|
|
132
|
+
* Hook to get current query params as an object inside any React Router router.
|
|
133
|
+
* MoleculeRouterProvider is optional; mount it only for named routes, the
|
|
134
|
+
* non-React navigate()/getRouter() bond, or onRouterReady.
|
|
121
135
|
*
|
|
122
136
|
* @returns Query params object
|
|
123
137
|
*
|
package/dist/hooks.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../src/hooks.tsx"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,EAEZ,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,cAAc,EAOpB,MAAM,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../src/hooks.tsx"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,EAEZ,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,cAAc,EAOpB,MAAM,OAAO,CAAA;AAad,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAOtE;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAA;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,EAAE,CAAA;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;CACzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,2BAA2B,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAgC5F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAqB1C;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAKlE;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAAC,UAAU,CAAC,CAGxD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,IAAI,WAAW,CAK9C;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,MAAM,GACX,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CA8ErD"}
|
package/dist/hooks.js
CHANGED
|
@@ -5,7 +5,7 @@ import { jsx as _jsx } from "react/jsx-runtime";
|
|
|
5
5
|
* @module
|
|
6
6
|
*/
|
|
7
7
|
import { createContext, useCallback, useContext, useEffect, useMemo, useRef, useState, } from 'react';
|
|
8
|
-
import { useLocation, useNavigate, useParams, useSearchParams } from 'react-router';
|
|
8
|
+
import { useInRouterContext, useLocation, useNavigate, useParams, useSearchParams, } from 'react-router';
|
|
9
9
|
import { t } from '@molecule/app-i18n';
|
|
10
10
|
import { setRouter } from '@molecule/app-routing';
|
|
11
11
|
import { createReactRouter } from './provider.js';
|
|
@@ -20,7 +20,8 @@ const MoleculeRouterContext = createContext(null);
|
|
|
20
20
|
* Bonding happens in an effect on mount (and again whenever the location/params
|
|
21
21
|
* change), so `@molecule/app-routing`'s `navigate()`/`getRouter()` drive THIS real
|
|
22
22
|
* React Router adapter — no manual `setRouter` wiring required. Mount it once inside
|
|
23
|
-
*
|
|
23
|
+
* any React Router router when non-React code needs the bond, named routes are
|
|
24
|
+
* configured, or `onRouterReady` is needed. The routing hooks work without this provider.
|
|
24
25
|
*
|
|
25
26
|
* @param props - The provider props (see {@link MoleculeRouterProviderProps}):
|
|
26
27
|
* `children` (rendered inside the router context), `routes` (optional named-route
|
|
@@ -75,10 +76,17 @@ export function MoleculeRouterProvider(props) {
|
|
|
75
76
|
return _jsx(MoleculeRouterContext.Provider, { value: router, children: children });
|
|
76
77
|
}
|
|
77
78
|
/**
|
|
78
|
-
* Hook to get the molecule Router
|
|
79
|
+
* Hook to get the molecule Router inside any React Router router, including
|
|
80
|
+
* BrowserRouter, HashRouter, MemoryRouter, Router, or RouterProvider from this
|
|
81
|
+
* package or React Router itself. No MoleculeRouterProvider is required.
|
|
82
|
+
*
|
|
83
|
+
* When MoleculeRouterProvider is mounted, returns its exact router with its named
|
|
84
|
+
* routes. Otherwise creates a local adapter from React Router's hooks without
|
|
85
|
+
* bonding it globally. Mount MoleculeRouterProvider for the non-React
|
|
86
|
+
* `@molecule/app-routing` navigate()/getRouter() bond or onRouterReady.
|
|
79
87
|
*
|
|
80
88
|
* @returns The molecule Router instance
|
|
81
|
-
* @throws {Error} If used outside
|
|
89
|
+
* @throws {Error} If used outside a React Router router; mount a router component.
|
|
82
90
|
*
|
|
83
91
|
* @example
|
|
84
92
|
* ```tsx
|
|
@@ -95,15 +103,23 @@ export function MoleculeRouterProvider(props) {
|
|
|
95
103
|
*/
|
|
96
104
|
export function useMoleculeRouter() {
|
|
97
105
|
const router = useContext(MoleculeRouterContext);
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
106
|
+
const inRouter = useInRouterContext();
|
|
107
|
+
if (!inRouter) {
|
|
108
|
+
throw new Error(t('routing.error.useMoleculeRouterOutsideRouter', undefined, {
|
|
109
|
+
defaultValue: 'useMoleculeRouter must be used within a React Router router. Mount BrowserRouter, HashRouter, MemoryRouter, Router, or RouterProvider.',
|
|
101
110
|
}));
|
|
102
111
|
}
|
|
103
|
-
|
|
112
|
+
// Always call the React Router hooks, including when the provider supplies the
|
|
113
|
+
// adapter. The guard above throws only for an invalid render outside any router.
|
|
114
|
+
const navigate = useNavigate();
|
|
115
|
+
const location = useLocation();
|
|
116
|
+
const params = useParams();
|
|
117
|
+
return useMemo(() => router ?? createReactRouter({ navigate, location, params }), [router, navigate, location, params]);
|
|
104
118
|
}
|
|
105
119
|
/**
|
|
106
|
-
* Hook to check if a path is currently active.
|
|
120
|
+
* Hook to check if a path is currently active inside any React Router router.
|
|
121
|
+
* MoleculeRouterProvider is optional; mount it only for named routes, the
|
|
122
|
+
* non-React navigate()/getRouter() bond, or onRouterReady.
|
|
107
123
|
*
|
|
108
124
|
* @param path - Path to check
|
|
109
125
|
* @param exact - Whether to require exact match
|
|
@@ -128,7 +144,9 @@ export function useIsActive(path, exact) {
|
|
|
128
144
|
return useMemo(() => router.isActive(path, exact), [router, path, exact, location.pathname]);
|
|
129
145
|
}
|
|
130
146
|
/**
|
|
131
|
-
* Hook to get a navigate function with molecule Router options
|
|
147
|
+
* Hook to get a navigate function with molecule Router options inside any React
|
|
148
|
+
* Router router. MoleculeRouterProvider is optional; mount it only for named
|
|
149
|
+
* routes, the non-React navigate()/getRouter() bond, or onRouterReady.
|
|
132
150
|
*
|
|
133
151
|
* @returns Navigate function
|
|
134
152
|
*
|
|
@@ -149,7 +167,9 @@ export function useMoleculeNavigate() {
|
|
|
149
167
|
return router.navigate.bind(router);
|
|
150
168
|
}
|
|
151
169
|
/**
|
|
152
|
-
* Hook to get current query params as an object.
|
|
170
|
+
* Hook to get current query params as an object inside any React Router router.
|
|
171
|
+
* MoleculeRouterProvider is optional; mount it only for named routes, the
|
|
172
|
+
* non-React navigate()/getRouter() bond, or onRouterReady.
|
|
153
173
|
*
|
|
154
174
|
* @returns Query params object
|
|
155
175
|
*
|
package/dist/hooks.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../src/hooks.tsx"],"names":[],"mappings":";AAAA;;;;GAIG;AAEH,OAAc,EACZ,aAAa,EAIb,WAAW,EACX,UAAU,EACV,SAAS,EACT,OAAO,EACP,MAAM,EACN,QAAQ,GACT,MAAM,OAAO,CAAA;AACd,OAAO,
|
|
1
|
+
{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../src/hooks.tsx"],"names":[],"mappings":";AAAA;;;;GAIG;AAEH,OAAc,EACZ,aAAa,EAIb,WAAW,EACX,UAAU,EACV,SAAS,EACT,OAAO,EACP,MAAM,EACN,QAAQ,GACT,MAAM,OAAO,CAAA;AACd,OAAO,EACL,kBAAkB,EAClB,WAAW,EACX,WAAW,EACX,SAAS,EACT,eAAe,GAChB,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,CAAC,EAAE,MAAM,oBAAoB,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAGjD;;GAEG;AACH,MAAM,qBAAqB,GAAG,aAAa,CAAgB,IAAI,CAAC,CAAA;AAsBhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAkC;IACvE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,EAAE,EAAE,aAAa,EAAE,GAAG,KAAK,CAAA;IACtD,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;IAC1B,eAAe,EAAE,CAAA,CAAC,oCAAoC;IAEtD,MAAM,MAAM,GAAG,OAAO,CACpB,GAAG,EAAE,CACH,iBAAiB,CAAC;QAChB,QAAQ;QACR,QAAQ,EAAE;YACR,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,GAAG,EAAE,QAAQ,CAAC,GAAG;SAClB;QACD,MAAM;QACN,MAAM;KACP,CAAC,EACJ,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CACrC,CAAA;IAED,SAAS,CAAC,GAAG,EAAE;QACb,gFAAgF;QAChF,gFAAgF;QAChF,SAAS,CAAC,MAAM,CAAC,CAAA;QACjB,aAAa,EAAE,CAAC,MAAM,CAAC,CAAA;IACzB,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAA;IAE3B,OAAO,KAAC,qBAAqB,CAAC,QAAQ,IAAC,KAAK,EAAE,MAAM,YAAG,QAAQ,GAAkC,CAAA;AACnG,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,MAAM,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAA;IAChD,MAAM,QAAQ,GAAG,kBAAkB,EAAE,CAAA;IACrC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CACb,CAAC,CAAC,8CAA8C,EAAE,SAAS,EAAE;YAC3D,YAAY,EACV,wIAAwI;SAC3I,CAAC,CACH,CAAA;IACH,CAAC;IAED,+EAA+E;IAC/E,iFAAiF;IACjF,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;IAC1B,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,MAAM,IAAI,iBAAiB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EACjE,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CACrC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,KAAe;IACvD,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAA;IAClC,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,oCAAoC;IACpC,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;AAC9F,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,mBAAmB;IACjC,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAA;IAClC,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AACrC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAA;IAClC,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,kCAAkC;IAClC,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;AACpE,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,sBAAsB,CACpC,IAAY;IAEZ,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;IACpE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAA;IACjD,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,GAAG,EAAkB,CAAC,CAAA;IACzD,MAAM,OAAO,GAAG,MAAM,CAAqB,SAAS,CAAC,CAAA;IACrD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IAC/B,MAAM,CAAC,OAAO,GAAG,QAAQ,CAAA;IAEzB,MAAM,cAAc,GAAG,WAAW,CAChC,CAAC,MAAM,EAAE,EAAE;QACT,WAAW,CAAC,CAAC,QAAQ,EAAE,EAAE;YACvB,MAAM,IAAI,GAAG,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;YACrE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;YAC/C,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;IACJ,CAAC,EACD,CAAC,QAAQ,CAAC,GAAG,CAAC,CACf,CAAA;IAED,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QACnD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAA;YACpC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAC/B,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;gBACvD,OAAO,CAAC,OAAO,GAAG,SAAS,CAAA;YAC7B,CAAC;iBAAM,IAAI,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrD,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC1B,yEAAyE;gBACzE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;YAC3D,CAAC;YACD,OAAM;QACR,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;QACpC,OAAO,CAAC,OAAO,GAAG,KAAK,CAAA;QACvB,WAAW,CAAC,KAAK,CAAC,CAAA;QAClB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACnB,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;QAChC,MAAM,oBAAoB,GACxB,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,MAAM,CAAC,OAAO,CAAC,KAAiB,CAAA;QAE/E,QAAQ,CACN;YACE,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE;YAClC,IAAI,EAAE,QAAQ,CAAC,IAAI;SACpB,EACD,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CACzC,CAAA;QAED,IACE,oBAAoB,KAAK,IAAI;YAC7B,OAAO,oBAAoB,KAAK,QAAQ;YACxC,OAAO,MAAM,KAAK,WAAW,EAC7B,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CACjC,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,MAAM,CACzC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAC1D,CACF,CAAA;YACD,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrC,MAAM,CAAC,OAAO,CAAC,YAAY,CACzB,EAAE,GAAG,QAAQ,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EACxC,EAAE,EACF,MAAM,CAAC,QAAQ,CAAC,IAAI,CACrB,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;IAE9B,OAAO;QACL,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC;QAClE,cAAc;KACN,CAAA;AACZ,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -4,6 +4,14 @@
|
|
|
4
4
|
* This package provides a React Router implementation of the molecule Router interface,
|
|
5
5
|
* allowing you to use molecule's routing abstractions with React Router.
|
|
6
6
|
*
|
|
7
|
+
* `useMoleculeRouter`, `useMoleculeQuery`, `useMoleculeNavigate`, and `useIsActive`
|
|
8
|
+
* work inside any React Router router (BrowserRouter, HashRouter, MemoryRouter,
|
|
9
|
+
* Router, or RouterProvider), from this package or React Router itself. No
|
|
10
|
+
* MoleculeRouterProvider is required for these hooks. Mount MoleculeRouterProvider
|
|
11
|
+
* only to bond the adapter for non-React `@molecule/app-routing` navigate()/getRouter(),
|
|
12
|
+
* supply named routes, or receive onRouterReady. Hook-created adapters remain local
|
|
13
|
+
* so multiple consumers cannot overwrite the global router bond.
|
|
14
|
+
*
|
|
7
15
|
* **Paginated or filtered page? Use `useListRoute` for its URL state.** It reads
|
|
8
16
|
* page, filters and selected views from the current URL; builds links that retain
|
|
9
17
|
* the current path/filters; and resets page when a filter or view changes. Declare
|
|
@@ -16,6 +24,7 @@
|
|
|
16
24
|
* import { BrowserRouter, MoleculeRouterProvider } from '@molecule/app-routing-react-router'
|
|
17
25
|
*
|
|
18
26
|
* function App() {
|
|
27
|
+
* // Optional: include this provider for non-React navigation or named routes.
|
|
19
28
|
* // MoleculeRouterProvider bonds the adapter automatically (calls setRouter in an
|
|
20
29
|
* // effect on mount), so @molecule/app-routing's navigate()/getRouter() drive THIS
|
|
21
30
|
* // real React Router — no manual setRouter wiring needed.
|
|
@@ -135,7 +144,7 @@
|
|
|
135
144
|
* - **Do NOT wire the exported `provider` const** in a React Router app — it is a
|
|
136
145
|
* no-hooks fallback (empty params, `window.location.href` navigation). Use
|
|
137
146
|
* `MoleculeRouterProvider` (or `createReactRouter` with hook values) instead.
|
|
138
|
-
* - The provider must live INSIDE
|
|
147
|
+
* - The provider must live INSIDE a React Router router (it calls React Router hooks).
|
|
139
148
|
* - **Import router components from this bond, never directly from React Router.**
|
|
140
149
|
* Its wrappers turn transitions off, so a navigation renders the new route in the
|
|
141
150
|
* same commit as the URL change. Import non-router APIs (`Routes`, `Route`, `Link`,
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+JG;AAEH,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,YAAY,EACV,WAAW,EACX,eAAe,EACf,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,UAAU,EACV,WAAW,EACX,YAAY,GACb,MAAM,YAAY,CAAA;AACnB,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -4,6 +4,14 @@
|
|
|
4
4
|
* This package provides a React Router implementation of the molecule Router interface,
|
|
5
5
|
* allowing you to use molecule's routing abstractions with React Router.
|
|
6
6
|
*
|
|
7
|
+
* `useMoleculeRouter`, `useMoleculeQuery`, `useMoleculeNavigate`, and `useIsActive`
|
|
8
|
+
* work inside any React Router router (BrowserRouter, HashRouter, MemoryRouter,
|
|
9
|
+
* Router, or RouterProvider), from this package or React Router itself. No
|
|
10
|
+
* MoleculeRouterProvider is required for these hooks. Mount MoleculeRouterProvider
|
|
11
|
+
* only to bond the adapter for non-React `@molecule/app-routing` navigate()/getRouter(),
|
|
12
|
+
* supply named routes, or receive onRouterReady. Hook-created adapters remain local
|
|
13
|
+
* so multiple consumers cannot overwrite the global router bond.
|
|
14
|
+
*
|
|
7
15
|
* **Paginated or filtered page? Use `useListRoute` for its URL state.** It reads
|
|
8
16
|
* page, filters and selected views from the current URL; builds links that retain
|
|
9
17
|
* the current path/filters; and resets page when a filter or view changes. Declare
|
|
@@ -16,6 +24,7 @@
|
|
|
16
24
|
* import { BrowserRouter, MoleculeRouterProvider } from '@molecule/app-routing-react-router'
|
|
17
25
|
*
|
|
18
26
|
* function App() {
|
|
27
|
+
* // Optional: include this provider for non-React navigation or named routes.
|
|
19
28
|
* // MoleculeRouterProvider bonds the adapter automatically (calls setRouter in an
|
|
20
29
|
* // effect on mount), so @molecule/app-routing's navigate()/getRouter() drive THIS
|
|
21
30
|
* // real React Router — no manual setRouter wiring needed.
|
|
@@ -135,7 +144,7 @@
|
|
|
135
144
|
* - **Do NOT wire the exported `provider` const** in a React Router app — it is a
|
|
136
145
|
* no-hooks fallback (empty params, `window.location.href` navigation). Use
|
|
137
146
|
* `MoleculeRouterProvider` (or `createReactRouter` with hook values) instead.
|
|
138
|
-
* - The provider must live INSIDE
|
|
147
|
+
* - The provider must live INSIDE a React Router router (it calls React Router hooks).
|
|
139
148
|
* - **Import router components from this bond, never directly from React Router.**
|
|
140
149
|
* Its wrappers turn transitions off, so a navigation renders the new route in the
|
|
141
150
|
* same commit as the URL change. Import non-router APIs (`Routes`, `Route`, `Link`,
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+JG;AAEH,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAe5B,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA"}
|