toiljs 0.0.15 → 0.0.16
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/.babelrc +13 -13
- package/.gitattributes +2 -2
- package/.github/ISSUE_TEMPLATE/bug_report.md +38 -38
- package/.github/ISSUE_TEMPLATE/bug_report.yml +90 -90
- package/.github/ISSUE_TEMPLATE/config.yml +8 -8
- package/.github/ISSUE_TEMPLATE/feature_request.md +20 -20
- package/.github/PULL_REQUEST_TEMPLATE.md +43 -43
- package/.github/changelog-config.json +45 -45
- package/.github/dependabot.yml +27 -27
- package/.github/workflows/ci.yml +191 -191
- package/.prettierrc.json +11 -11
- package/.vscode/settings.json +9 -9
- package/CHANGELOG.md +5 -5
- package/LICENSE +187 -187
- package/README.md +339 -315
- package/as-pect.asconfig.json +34 -34
- package/as-pect.config.js +65 -65
- package/assets/logo.svg +36 -36
- package/build/backend/.tsbuildinfo +1 -1
- package/build/cli/.tsbuildinfo +1 -1
- package/build/cli/index.js +0 -0
- package/build/client/.tsbuildinfo +1 -1
- package/build/client/dev/devtools.d.ts +6 -0
- package/build/client/dev/devtools.js +442 -0
- package/build/client/dev/error-overlay.d.ts +9 -0
- package/build/client/dev/error-overlay.js +19 -4
- package/build/client/navigation/prefetch.d.ts +1 -0
- package/build/client/navigation/prefetch.js +35 -0
- package/build/client/routing/Router.js +1 -1
- package/build/client/routing/hooks.js +6 -2
- package/build/client/routing/loader.d.ts +23 -0
- package/build/client/routing/loader.js +53 -7
- package/build/client/routing/mount.js +4 -3
- package/build/compiler/.tsbuildinfo +1 -1
- package/build/compiler/config.d.ts +16 -0
- package/build/compiler/config.js +7 -0
- package/build/compiler/docs.js +16 -16
- package/build/compiler/index.d.ts +2 -2
- package/build/compiler/index.js +1 -1
- package/build/compiler/plugin.js +156 -0
- package/build/compiler/prerender.d.ts +1 -0
- package/build/compiler/prerender.js +1 -1
- package/build/compiler/seo.d.ts +1 -1
- package/build/compiler/seo.js +5 -4
- package/build/compiler/ssg.js +32 -1
- package/build/io/.tsbuildinfo +1 -1
- package/build/logger/.tsbuildinfo +1 -1
- package/build/shared/.tsbuildinfo +1 -1
- package/eslint.config.js +48 -48
- package/examples/basic/client/404.tsx +11 -11
- package/examples/basic/client/components/.gitkeep +1 -1
- package/examples/basic/client/global-error.tsx +13 -13
- package/examples/basic/client/layout.tsx +25 -25
- package/examples/basic/client/public/images/.gitkeep +1 -1
- package/examples/basic/client/public/images/logo.svg +36 -36
- package/examples/basic/client/public/robots.txt +2 -2
- package/examples/basic/client/routes/docs/[...slug].tsx +12 -12
- package/examples/basic/client/routes/features/error/error.tsx +16 -16
- package/examples/basic/client/routes/features/template/b.tsx +14 -14
- package/examples/basic/client/routes/files/[[...slug]].tsx +21 -21
- package/examples/basic/client/routes/gallery/layout.tsx +13 -13
- package/examples/basic/client/routes/io.tsx +24 -24
- package/examples/basic/client/routes/loader-demo/loading.tsx +13 -13
- package/examples/basic/client/routes/search.tsx +61 -61
- package/examples/basic/client/toil.tsx +5 -5
- package/package.json +155 -148
- package/presets/eslint.js +88 -88
- package/presets/no-uint8array-tostring.js +200 -200
- package/presets/prettier.json +18 -18
- package/presets/tsconfig.json +37 -37
- package/src/backend/index.ts +160 -160
- package/src/cli/proc.ts +50 -50
- package/src/cli/updates.ts +69 -69
- package/src/cli/validate.ts +31 -31
- package/src/client/channel/channel.ts +146 -146
- package/src/client/components/Form.tsx +65 -65
- package/src/client/components/Script.tsx +113 -113
- package/src/client/components/Slot.tsx +21 -21
- package/src/client/dev/devtools.tsx +973 -0
- package/src/client/dev/error-overlay.tsx +30 -4
- package/src/client/head/head.ts +167 -167
- package/src/client/head/metadata.ts +112 -112
- package/src/client/index.ts +89 -89
- package/src/client/navigation/NavLink.tsx +86 -86
- package/src/client/navigation/navigation.ts +235 -235
- package/src/client/navigation/prefetch.ts +169 -130
- package/src/client/navigation/scroll.ts +53 -53
- package/src/client/routing/Router.tsx +8 -2
- package/src/client/routing/action.ts +122 -122
- package/src/client/routing/error-boundary.tsx +43 -43
- package/src/client/routing/hooks.ts +21 -6
- package/src/client/routing/loader.ts +325 -235
- package/src/client/routing/match.ts +47 -47
- package/src/client/routing/mount.tsx +54 -52
- package/src/client/routing/params-context.ts +10 -10
- package/src/client/routing/slot-context.ts +7 -7
- package/src/client/search/search.ts +189 -189
- package/src/client/search/use-page-search.ts +73 -73
- package/src/client/types.ts +73 -73
- package/src/compiler/config.ts +219 -182
- package/src/compiler/docs.ts +228 -228
- package/src/compiler/generate.ts +394 -394
- package/src/compiler/index.ts +64 -57
- package/src/compiler/pages.ts +70 -70
- package/src/compiler/plugin.ts +170 -2
- package/src/compiler/prerender.ts +156 -156
- package/src/compiler/seo.ts +397 -390
- package/src/compiler/ssg.ts +162 -126
- package/src/io/BinaryReader.ts +340 -340
- package/src/io/BinaryWriter.ts +385 -385
- package/src/io/FastMap.ts +127 -127
- package/src/io/index.ts +11 -11
- package/src/io/lengths.ts +14 -14
- package/src/io/types.ts +18 -18
- package/src/logger/index.ts +22 -22
- package/src/server/index.ts +10 -10
- package/src/server/main.ts +13 -13
- package/src/server/tsconfig.json +4 -4
- package/src/shared/index.ts +10 -10
- package/std/client/index.d.ts +15 -15
- package/std/client/package.json +3 -3
- package/test/assembly/example.spec.ts +7 -7
- package/test/channel.test.ts +21 -21
- package/test/dom/Link.test.tsx +47 -47
- package/test/dom/NavLink.test.tsx +37 -37
- package/test/dom/error-overlay.test.tsx +44 -44
- package/test/dom/loader.test.tsx +121 -121
- package/test/dom/navigation.test.ts +59 -59
- package/test/dom/revalidate.test.tsx +38 -38
- package/test/dom/route-head.test.tsx +78 -78
- package/test/dom/router-loading.test.tsx +44 -44
- package/test/dom/scroll.test.ts +56 -56
- package/test/dom/use-metadata.test.tsx +58 -58
- package/test/io.test.ts +93 -93
- package/test/navlink.test.ts +28 -28
- package/test/placeholder.test.ts +9 -9
- package/test/routes.test.ts +76 -76
- package/test/seo.test.ts +175 -164
- package/test/slot-layouts.test.ts +69 -69
- package/test/ssg.test.ts +36 -36
- package/test/update.test.ts +44 -44
- package/test/validate.test.ts +42 -42
- package/toil-routes.d.ts +7 -0
- package/toilconfig.json +30 -30
- package/tsconfig.backend.json +13 -13
- package/tsconfig.base.json +35 -35
- package/tsconfig.cli.json +13 -13
- package/tsconfig.client.json +14 -14
- package/tsconfig.compiler.json +13 -13
- package/tsconfig.io.json +12 -12
- package/tsconfig.json +22 -22
- package/tsconfig.logger.json +12 -12
- package/tsconfig.server.json +10 -10
- package/tsconfig.shared.json +12 -12
- package/vitest.config.ts +26 -26
- package/.idea/codeStyles/Project.xml +0 -54
- package/.idea/codeStyles/codeStyleConfig.xml +0 -5
- package/.idea/inspectionProfiles/Project_Default.xml +0 -6
- package/.idea/modules.xml +0 -8
- package/.idea/prettier.xml +0 -7
- package/.idea/toiljs.iml +0 -8
- package/.idea/vcs.xml +0 -6
- package/.toil/entry.tsx +0 -9
- package/.toil/index.html +0 -12
- package/.toil/routes.ts +0 -9
- package/build/cli/configure.d.ts +0 -16
- package/build/cli/configure.js +0 -272
- package/build/cli/create.d.ts +0 -16
- package/build/cli/create.js +0 -420
- package/build/cli/diagnostics.d.ts +0 -55
- package/build/cli/diagnostics.js +0 -333
- package/build/cli/doctor.d.ts +0 -6
- package/build/cli/doctor.js +0 -249
- package/build/cli/features.d.ts +0 -25
- package/build/cli/features.js +0 -107
- package/build/cli/index.d.ts +0 -2
- package/build/cli/proc.d.ts +0 -6
- package/build/cli/proc.js +0 -31
- package/build/cli/ui.d.ts +0 -9
- package/build/cli/ui.js +0 -75
- package/build/cli/update.d.ts +0 -7
- package/build/cli/update.js +0 -117
- package/build/cli/updates.d.ts +0 -10
- package/build/cli/updates.js +0 -45
- package/build/cli/validate.d.ts +0 -4
- package/build/cli/validate.js +0 -19
- package/build/client/Link.d.ts +0 -8
- package/build/client/Link.js +0 -44
- package/build/client/NavLink.d.ts +0 -14
- package/build/client/NavLink.js +0 -37
- package/build/client/Router.d.ts +0 -7
- package/build/client/Router.js +0 -55
- package/build/client/channel.d.ts +0 -23
- package/build/client/channel.js +0 -94
- package/build/client/error-boundary.d.ts +0 -16
- package/build/client/error-boundary.js +0 -19
- package/build/client/head.d.ts +0 -26
- package/build/client/head.js +0 -87
- package/build/client/hooks.d.ts +0 -17
- package/build/client/hooks.js +0 -48
- package/build/client/lazy.d.ts +0 -16
- package/build/client/lazy.js +0 -53
- package/build/client/match.d.ts +0 -2
- package/build/client/match.js +0 -32
- package/build/client/mount.d.ts +0 -2
- package/build/client/mount.js +0 -13
- package/build/client/navigation.d.ts +0 -13
- package/build/client/navigation.js +0 -97
- package/build/client/params-context.d.ts +0 -2
- package/build/client/params-context.js +0 -2
- package/build/client/prefetch.d.ts +0 -11
- package/build/client/prefetch.js +0 -100
- package/build/client/runtime.d.ts +0 -31
- package/build/client/runtime.js +0 -112
- package/build/client/scroll.d.ts +0 -8
- package/build/client/scroll.js +0 -36
- package/toil-env.d.ts +0 -16
|
@@ -1,130 +1,169 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
readonly
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
*
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
1
|
+
import { prefetchRouteData } from '../routing/loader.js';
|
|
2
|
+
import { matchRoute } from '../routing/match.js';
|
|
3
|
+
import type { RouteDef } from '../types.js';
|
|
4
|
+
|
|
5
|
+
declare global {
|
|
6
|
+
interface Navigator {
|
|
7
|
+
/** Non-standard but widely shipped; used to skip prefetch on data-saver / slow links. */
|
|
8
|
+
readonly connection?: {
|
|
9
|
+
readonly saveData?: boolean;
|
|
10
|
+
readonly effectiveType?: string;
|
|
11
|
+
};
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
let routeTable: RouteDef[] = [];
|
|
16
|
+
const warmed = new WeakSet<RouteDef>();
|
|
17
|
+
const dataWarmed = new Set<string>();
|
|
18
|
+
let io: IntersectionObserver | null = null;
|
|
19
|
+
let mo: MutationObserver | null = null;
|
|
20
|
+
|
|
21
|
+
/** Resolves a same-origin `href` to a registered route, or `null` for external/unknown targets. */
|
|
22
|
+
function routeForHref(href: string): RouteDef | null {
|
|
23
|
+
let url: URL;
|
|
24
|
+
try {
|
|
25
|
+
url = new URL(href, window.location.href);
|
|
26
|
+
} catch {
|
|
27
|
+
return null;
|
|
28
|
+
}
|
|
29
|
+
if (url.origin !== window.location.origin) return null;
|
|
30
|
+
for (const route of routeTable) {
|
|
31
|
+
if (matchRoute(route.pattern, url.pathname)) return route;
|
|
32
|
+
}
|
|
33
|
+
return null;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Warms a route's lazy chunk by triggering its loader once. Best-effort: each route loads at most
|
|
38
|
+
* once, and a failed load is forgotten (so the real navigation can retry and surface the error).
|
|
39
|
+
*/
|
|
40
|
+
function warm(route: RouteDef): void {
|
|
41
|
+
if (warmed.has(route)) return;
|
|
42
|
+
warmed.add(route);
|
|
43
|
+
void route.load().catch(() => {
|
|
44
|
+
warmed.delete(route);
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Prefetches the route chunk for an internal `href` so a later navigation resolves instantly.
|
|
50
|
+
* No-op for external, unknown, or already-prefetched targets, safe to call from anywhere,
|
|
51
|
+
* including before an imperative {@link navigate} (e.g. `prefetch('/dashboard')` on hover/intent).
|
|
52
|
+
*/
|
|
53
|
+
export function prefetch(href: string): void {
|
|
54
|
+
const route = routeForHref(href);
|
|
55
|
+
if (route) warm(route);
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Prefetches both the chunk and the loader data for an internal `href`, so a later navigation
|
|
60
|
+
* commits synchronously (no suspense, no held-page wait). Called on link hover / focus intent, where
|
|
61
|
+
* running the route's loader early is worth it. No-op for external/unknown/already-warmed targets.
|
|
62
|
+
*/
|
|
63
|
+
export function prefetchData(href: string): void {
|
|
64
|
+
let url: URL;
|
|
65
|
+
try {
|
|
66
|
+
url = new URL(href, window.location.href);
|
|
67
|
+
} catch {
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
if (url.origin !== window.location.origin) return;
|
|
71
|
+
const key = url.pathname + url.search;
|
|
72
|
+
if (dataWarmed.has(key)) return;
|
|
73
|
+
for (const route of routeTable) {
|
|
74
|
+
const params = matchRoute(route.pattern, url.pathname);
|
|
75
|
+
if (params) {
|
|
76
|
+
dataWarmed.add(key);
|
|
77
|
+
warm(route);
|
|
78
|
+
prefetchRouteData(route, params, url.pathname, url.search);
|
|
79
|
+
return;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/** Anchors to skip even when internal: new-tab, downloads, or an explicit `data-no-prefetch` opt-out. */
|
|
85
|
+
function isPrefetchable(a: HTMLAnchorElement): boolean {
|
|
86
|
+
if (a.target && a.target !== '_self') return false;
|
|
87
|
+
if (a.hasAttribute('download')) return false;
|
|
88
|
+
if (a.dataset.noPrefetch !== undefined) return false;
|
|
89
|
+
return true;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/** Observes an anchor for viewport entry if it points at a known internal route. */
|
|
93
|
+
function observeAnchor(a: HTMLAnchorElement): void {
|
|
94
|
+
if (!io || !isPrefetchable(a) || !routeForHref(a.href)) return;
|
|
95
|
+
io.observe(a);
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
/** Finds and observes every `<a href>` under `root`. */
|
|
99
|
+
function scan(root: ParentNode): void {
|
|
100
|
+
root.querySelectorAll('a[href]').forEach((el) => {
|
|
101
|
+
if (el instanceof HTMLAnchorElement) observeAnchor(el);
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/** Skip prefetching on data-saver mode or 2g-class connections, where bandwidth is precious. */
|
|
106
|
+
function shouldSkipForConnection(): boolean {
|
|
107
|
+
const c = navigator.connection;
|
|
108
|
+
if (!c) return false;
|
|
109
|
+
return c.saveData === true || c.effectiveType === 'slow-2g' || c.effectiveType === '2g';
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* Starts idle-time prefetching of internal links. As each `<a>` pointing at a known route scrolls
|
|
114
|
+
* into view (or near it, 200px margin) its chunk is warmed once; links added later by client
|
|
115
|
+
* navigation are picked up via a MutationObserver. Called by {@link mount}; runs once per app.
|
|
116
|
+
*/
|
|
117
|
+
export function startPrefetcher(routes: RouteDef[]): void {
|
|
118
|
+
routeTable = routes;
|
|
119
|
+
if (
|
|
120
|
+
typeof window === 'undefined' ||
|
|
121
|
+
typeof IntersectionObserver === 'undefined' ||
|
|
122
|
+
typeof MutationObserver === 'undefined' ||
|
|
123
|
+
io
|
|
124
|
+
) {
|
|
125
|
+
return;
|
|
126
|
+
}
|
|
127
|
+
if (shouldSkipForConnection()) return;
|
|
128
|
+
|
|
129
|
+
io = new IntersectionObserver(
|
|
130
|
+
(entries) => {
|
|
131
|
+
for (const entry of entries) {
|
|
132
|
+
if (!entry.isIntersecting) continue;
|
|
133
|
+
const a = entry.target;
|
|
134
|
+
if (a instanceof HTMLAnchorElement) {
|
|
135
|
+
io?.unobserve(a);
|
|
136
|
+
prefetch(a.href);
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
},
|
|
140
|
+
{ rootMargin: '200px' },
|
|
141
|
+
);
|
|
142
|
+
|
|
143
|
+
mo = new MutationObserver((mutations) => {
|
|
144
|
+
for (const m of mutations) {
|
|
145
|
+
for (const node of m.addedNodes) {
|
|
146
|
+
if (node instanceof HTMLAnchorElement) observeAnchor(node);
|
|
147
|
+
else if (node instanceof Element) scan(node);
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
// Hover / focus intent: warm the chunk *and* run the loader for the target so the click commits
|
|
153
|
+
// synchronously. Delegated on the document so links added later are covered automatically.
|
|
154
|
+
const onIntent = (event: Event): void => {
|
|
155
|
+
const target = event.target;
|
|
156
|
+
if (!(target instanceof Element)) return;
|
|
157
|
+
const a = target.closest('a[href]');
|
|
158
|
+
if (a instanceof HTMLAnchorElement && isPrefetchable(a) && a.href) prefetchData(a.href);
|
|
159
|
+
};
|
|
160
|
+
document.addEventListener('pointerover', onIntent, { passive: true });
|
|
161
|
+
document.addEventListener('focusin', onIntent);
|
|
162
|
+
|
|
163
|
+
const begin = (): void => {
|
|
164
|
+
scan(document);
|
|
165
|
+
mo?.observe(document.body, { childList: true, subtree: true });
|
|
166
|
+
};
|
|
167
|
+
if (typeof requestIdleCallback === 'function') requestIdleCallback(begin);
|
|
168
|
+
else setTimeout(begin, 200);
|
|
169
|
+
}
|
|
@@ -1,53 +1,53 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Manual scroll management for client navigation: scroll to top on push navigations, restore the
|
|
3
|
-
* saved position on back/forward, and honor in-page `#hash` targets. Positions are keyed by
|
|
4
|
-
* history entry; {@link applyScroll} runs once after the navigation commits.
|
|
5
|
-
*/
|
|
6
|
-
const positions = new Map<string, number>();
|
|
7
|
-
|
|
8
|
-
interface ScrollPlan {
|
|
9
|
-
readonly restore: number | null;
|
|
10
|
-
readonly hash: string;
|
|
11
|
-
readonly toTop: boolean;
|
|
12
|
-
}
|
|
13
|
-
let plan: ScrollPlan | null = null;
|
|
14
|
-
|
|
15
|
-
/** Switches off the browser's automatic scroll restoration so the router can manage it. */
|
|
16
|
-
export function enableManualScrollRestoration(): void {
|
|
17
|
-
if (typeof window !== 'undefined' && 'scrollRestoration' in window.history) {
|
|
18
|
-
window.history.scrollRestoration = 'manual';
|
|
19
|
-
}
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
/** Saves the current scroll position for a history key (called before leaving an entry). */
|
|
23
|
-
export function rememberScroll(key: string): void {
|
|
24
|
-
positions.set(key, window.scrollY);
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
/** Plans what {@link applyScroll} should do after the next navigation commits. */
|
|
28
|
-
export function planScroll(opts: { restoreKey?: string; hash: string; toTop: boolean }): void {
|
|
29
|
-
plan = {
|
|
30
|
-
restore: opts.restoreKey !== undefined ? (positions.get(opts.restoreKey) ?? 0) : null,
|
|
31
|
-
hash: opts.hash,
|
|
32
|
-
toTop: opts.toTop,
|
|
33
|
-
};
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
/** Applies the pending scroll plan once: hash target, else restored position, else top. */
|
|
37
|
-
export function applyScroll(): void {
|
|
38
|
-
const current = plan;
|
|
39
|
-
plan = null;
|
|
40
|
-
if (!current) return;
|
|
41
|
-
if (current.hash) {
|
|
42
|
-
const el = document.getElementById(decodeURIComponent(current.hash.slice(1)));
|
|
43
|
-
if (el) {
|
|
44
|
-
el.scrollIntoView();
|
|
45
|
-
return;
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
if (current.restore !== null) {
|
|
49
|
-
window.scrollTo(0, current.restore);
|
|
50
|
-
return;
|
|
51
|
-
}
|
|
52
|
-
if (current.toTop) window.scrollTo(0, 0);
|
|
53
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Manual scroll management for client navigation: scroll to top on push navigations, restore the
|
|
3
|
+
* saved position on back/forward, and honor in-page `#hash` targets. Positions are keyed by
|
|
4
|
+
* history entry; {@link applyScroll} runs once after the navigation commits.
|
|
5
|
+
*/
|
|
6
|
+
const positions = new Map<string, number>();
|
|
7
|
+
|
|
8
|
+
interface ScrollPlan {
|
|
9
|
+
readonly restore: number | null;
|
|
10
|
+
readonly hash: string;
|
|
11
|
+
readonly toTop: boolean;
|
|
12
|
+
}
|
|
13
|
+
let plan: ScrollPlan | null = null;
|
|
14
|
+
|
|
15
|
+
/** Switches off the browser's automatic scroll restoration so the router can manage it. */
|
|
16
|
+
export function enableManualScrollRestoration(): void {
|
|
17
|
+
if (typeof window !== 'undefined' && 'scrollRestoration' in window.history) {
|
|
18
|
+
window.history.scrollRestoration = 'manual';
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/** Saves the current scroll position for a history key (called before leaving an entry). */
|
|
23
|
+
export function rememberScroll(key: string): void {
|
|
24
|
+
positions.set(key, window.scrollY);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/** Plans what {@link applyScroll} should do after the next navigation commits. */
|
|
28
|
+
export function planScroll(opts: { restoreKey?: string; hash: string; toTop: boolean }): void {
|
|
29
|
+
plan = {
|
|
30
|
+
restore: opts.restoreKey !== undefined ? (positions.get(opts.restoreKey) ?? 0) : null,
|
|
31
|
+
hash: opts.hash,
|
|
32
|
+
toTop: opts.toTop,
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/** Applies the pending scroll plan once: hash target, else restored position, else top. */
|
|
37
|
+
export function applyScroll(): void {
|
|
38
|
+
const current = plan;
|
|
39
|
+
plan = null;
|
|
40
|
+
if (!current) return;
|
|
41
|
+
if (current.hash) {
|
|
42
|
+
const el = document.getElementById(decodeURIComponent(current.hash.slice(1)));
|
|
43
|
+
if (el) {
|
|
44
|
+
el.scrollIntoView();
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
if (current.restore !== null) {
|
|
49
|
+
window.scrollTo(0, current.restore);
|
|
50
|
+
return;
|
|
51
|
+
}
|
|
52
|
+
if (current.toTop) window.scrollTo(0, 0);
|
|
53
|
+
}
|
|
@@ -68,13 +68,19 @@ function renderMatched(
|
|
|
68
68
|
|
|
69
69
|
// A route with a `loading.tsx` keys its boundary per URL *and* navigation epoch, so its fallback
|
|
70
70
|
// shows even inside the transition, on first nav and on an in-place revalidate of the same URL
|
|
71
|
-
// (the epoch bumps). A route without one keeps a
|
|
72
|
-
//
|
|
71
|
+
// (the epoch bumps). A route without one keeps a STABLE boundary (key `undefined`): the Suspense
|
|
72
|
+
// must NOT be remounted on navigation, or it becomes a freshly-mounted boundary with no committed
|
|
73
|
+
// content and React shows its (null) fallback during the next route's chunk/loader load, i.e. a
|
|
74
|
+
// blank flash, even inside the transition. With a stable boundary the transition holds the old
|
|
75
|
+
// page until the next one is ready. The loader cache key stays the bare URL, so reused data hits.
|
|
76
|
+
// The page itself is keyed by URL so each route mounts fresh (no state bleed between routes); it
|
|
77
|
+
// lives INSIDE the boundary so that re-mount doesn't tear down the boundary above it.
|
|
73
78
|
let content: ReactNode = (
|
|
74
79
|
<Suspense
|
|
75
80
|
key={matched.loading ? `${dataKey}:${String(epoch)}` : undefined}
|
|
76
81
|
fallback={fallback}>
|
|
77
82
|
<RoutePage
|
|
83
|
+
key={dataKey}
|
|
78
84
|
route={matched}
|
|
79
85
|
params={params}
|
|
80
86
|
dataKey={dataKey}
|