@devzwo/ngx-magic-scroll 0.0.0-stage → 0.0.1-rc.2

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/LICENSE ADDED
@@ -0,0 +1,33 @@
1
+ Copyright 2026 devZWO GmbH
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
+
5
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
+
7
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
8
+
9
+ ------------------------------------------------------------------------
10
+ Third-party code: internal helpers adapted from ngxtension 7.3.1
11
+ See THIRD_PARTY_NOTICES.txt for provenance and modifications.
12
+
13
+ MIT License
14
+
15
+ Copyright (c) 2023 Chau Tran
16
+
17
+ Permission is hereby granted, free of charge, to any person obtaining a copy
18
+ of this software and associated documentation files (the "Software"), to deal
19
+ in the Software without restriction, including without limitation the rights
20
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
21
+ copies of the Software, and to permit persons to whom the Software is
22
+ furnished to do so, subject to the following conditions:
23
+
24
+ The above copyright notice and this permission notice shall be included in all
25
+ copies or substantial portions of the Software.
26
+
27
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
30
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
31
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
32
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,124 @@
1
- # Temporary Holding Version
1
+ # @devzwo/ngx-magic-scroll
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ [![Angular](https://img.shields.io/badge/Angular-22+-DD0031?style=flat-square&logo=angular)](https://angular.dev)
4
+ [![CI](https://img.shields.io/github/actions/workflow/status/devZWO/ngx-magic-scroll/ci.yml?style=flat-square)](https://github.com/devZWO/ngx-signal-schema/actions/workflows/ci.yml)
5
+ [![codecov](https://img.shields.io/codecov/c/github/devzwo/ngx-magic-scroll?style=flat-square)](https://codecov.io/github/devZWO/ngx-magic-scroll)
6
+ [![NPM Version](https://img.shields.io/npm/v/@devzwo/ngx-magic-scroll?style=flat-square)](https://npmjs.org/package/@devzwo/ngx-magic-scroll)
7
+ [![License](https://img.shields.io/npm/l/%40devzwo%2Fngx-magic-scroll?style=flat-square)](https://github.com/devZWO/ngx-magic-scroll/blob/main/LICENSE)
8
+
9
+ Anchor scrolling, URL synchronization and position restoration for Angular.
10
+
11
+ **Pre-release:** the API is still under review. Requires Angular 22.2 and RxJS 7.8. See `package.json` for precise ranges.
12
+
13
+ ## Minimal usage
14
+
15
+ Import `MagicScrollDirective` in your standalone component. Angular Router must be provided by the application.
16
+
17
+ ```html
18
+ <div magicScroll>
19
+ <section id="project-1">...</section>
20
+ <section id="project-2">...</section>
21
+ </div>
22
+ ```
23
+
24
+ All descendant IDs participate by default. The directive finds the scroll container automatically, including a scrollable host or the document. It synchronizes the URL fragment while scrolling and restores an initial fragment once after rendering. This is enough for static content or data already loaded by a router resolver.
25
+
26
+ For asynchronous content, pass the source directly:
27
+
28
+ ```ts
29
+ readonly projects = rxResource({ stream: () => this.api.loadProjects() });
30
+ ```
31
+
32
+ ```html
33
+ <div magicScroll [scrollSource]="projects">
34
+ @for (project of projects.value(); track project.id) {
35
+ <section [id]="'project-' + project.id">...</section>
36
+ }
37
+ </div>
38
+ ```
39
+
40
+ The application renders its loading/error states; when a resource can fail, guard `value()` with `hasValue()` in the template. The facade handles this guard internally for scroll readiness.
41
+
42
+ ## Defaults and overrides
43
+
44
+ Register defaults in `app.config.ts` or a component's providers:
45
+
46
+ ```ts
47
+ provideMagicScroll({
48
+ anchorPrefix: 'project-',
49
+ headerSelector: '.app-header',
50
+ headerOffset: 16,
51
+ behavior: { restoration: 'instant', interaction: 'smooth' },
52
+ });
53
+ ```
54
+
55
+ The header's height is measured and observed automatically. `headerOffset` is an additional gap below it, or the full offset without a header. Defaults are an empty prefix and header selector, zero offset, a 500 ms scroll-spy debounce, instant restoration and smooth interaction.
56
+
57
+ Child providers inherit unspecified settings. Override an individual region with `[scrollOptions]="options"`; unspecified fields still inherit. Explicit `0`, `false` and `anchorPrefix: ''` override inherited values.
58
+
59
+ ```html
60
+ <div
61
+ magicScroll
62
+ #scroll="magicScroll"
63
+ [scrollSource]="projects"
64
+ [scrollOptions]="{ headerOffset: 24 }"
65
+ >
66
+ ...
67
+ </div>
68
+ <button (click)="scroll.scrollTo('project-2')">Project 2</button>
69
+ ```
70
+
71
+ `scrollTo()` is a deliberate user action and returns whether scrolling was executed. Per-call `behavior`, `topOffset` (the full offset) and `ignoreWhenInView` override the region defaults. `scroll.activeAnchor()` exposes the current fragment for navigation highlighting; `scroll.headerHeight()` and `scroll.offset()` can position a sticky companion panel.
72
+
73
+ Navigation, reload and the first successful asynchronous load use `behavior.restoration`. Later data changes and resize/header corrections adjust instantly to stabilize the layout. `restoreOnDataChange: false` and `preserveOnResize: false` opt out of data corrections and resize/header corrections respectively. Visibility rules are: `none`, `top`, `full` and `always` (at least one edge visible).
74
+
75
+ ## Optional explicit anchors
76
+
77
+ No marker is needed for normal IDs. An explicit anchor participates even outside the configured prefix:
78
+
79
+ ```html
80
+ <section id="overview" scrollAnchor>...</section>
81
+ <section [scrollAnchor]="'project-' + project.id">...</section>
82
+ ```
83
+
84
+ The second form sets the ID as well. Targets are restricted to their own `magicScroll` region; nested regions own their own anchors. IDs must be unique in the document.
85
+
86
+ ## Supported data sources
87
+
88
+ `scrollSource` accepts signals (including computed, writable, input and model signals), Angular `resource`/`rxResource`, a signal containing a resource, and plain input values. For signal forms, pass the field's value signal, such as `form().value`; no Angular Forms dependency is needed.
89
+
90
+ A supplied source waits while it is loading or its data is `null`/`undefined`. Empty arrays, `0`, `false` and empty strings are ready values. Omitting the input means static content; explicitly binding an initially undefined value waits for data. Once the first ready render has been handled, a missing target is not retried as a second initial restoration.
91
+
92
+ The neutral `ScrollDataSource` contract remains available:
93
+
94
+ ```ts
95
+ readonly source = { data: this.items, isLoading: this.loading };
96
+ ```
97
+
98
+ Reactive getters must read signals. TanStack query results can satisfy this contract without a package dependency. Supabase responses can be stored in data/loading signals and exposed with the same contract. Fetching, errors, pagination and caching stay with the application; a bare Supabase client or Promise is not a loading-state adapter.
99
+
100
+ ## Public API and migration
101
+
102
+ The package exports `MagicScrollDirective`, `ScrollAnchorDirective` and `provideMagicScroll`,
103
+ plus the consumer-facing types `MagicScrollOptions`, `MagicScrollToOptions`, `ScrollSource`,
104
+ `ScrollResource` and `ScrollDataSource`. Low-level services, automatic directives, configuration
105
+ internals and reactive helpers are implementation details and cannot be imported from the package.
106
+
107
+ Replace the former combination of scroll-spy, first-data, data-change and resize directives with
108
+ `magicScroll`. Pass the resource instead of a resource adapter, move options to
109
+ `provideMagicScroll`/`scrollOptions`, and use `scroll.scrollTo()` instead of locating a scroll
110
+ container manually. The existing scroll implementation remains internal to the facade.
111
+
112
+ ## Demo and verification
113
+
114
+ Four routed examples demonstrate document synchronization, asynchronous navigation restoration, Material `mat-drawer-container` with pagination, and master–detail document scrolling with a measured sticky header. Options are presented inside these demos.
115
+
116
+ `pnpm test:ci` enforces 100% statements, branches, functions and lines per library implementation file. The existing 25 E2E scenarios remain unchanged after the migration to the facade and pass in Chromium, Firefox and WebKit (75 runs).
117
+
118
+ [Documentation and API](https://devzwo.github.io/ngx-magic-scroll/) · [Source and issues](https://github.com/devZWO/ngx-magic-scroll)
119
+
120
+ MIT, copyright 2026 devZWO GmbH.
121
+
122
+ Two internal helpers are adapted from ngxtension 7.3.1 under the MIT license. See [THIRD_PARTY_NOTICES.txt](./THIRD_PARTY_NOTICES.txt) for their origin, local changes and original license.
123
+
124
+ Production builds retain the original MIT notice in the JavaScript bundle for license extraction. Applications redistributing this code must retain its copyright and license notices, including when minifying or rebundling it.
@@ -0,0 +1,38 @@
1
+ Third-party code notices
2
+
3
+ ngxtension 7.3.1
4
+ Repository: https://github.com/ngxtension/ngxtension-platform
5
+ Upstream commit: ac24352d2b2a4502faf2ff1fc54c241316093c65
6
+
7
+ Local file: src/lib/effects/effect-once-if.ts
8
+ Source: https://github.com/ngxtension/ngxtension-platform/blob/ac24352d2b2a4502faf2ff1fc54c241316093c65/libs/ngxtension/effect-once-if/src/effect-once-if.ts
9
+ Changes: Narrowed to a boolean predicate, a parameterless action and an explicit injector; removed generic options and injector assertion.
10
+
11
+ Local file: src/lib/navigation/inject-route-fragment.ts
12
+ Source: https://github.com/ngxtension/ngxtension-platform/blob/ac24352d2b2a4502faf2ff1fc54c241316093c65/libs/ngxtension/inject-route-fragment/src/inject-route-fragment.ts
13
+ Changes: Removed parsing, transformations, defaults and custom injector options; retained snapshot initialization and Angular-managed subscription cleanup.
14
+
15
+ These adapted helpers are maintained locally. When upgrading Angular, review
16
+ the corresponding upstream helpers for relevant fixes. No ngxtension API is exported.
17
+
18
+ MIT License
19
+
20
+ Copyright (c) 2023 Chau Tran
21
+
22
+ Permission is hereby granted, free of charge, to any person obtaining a copy
23
+ of this software and associated documentation files (the "Software"), to deal
24
+ in the Software without restriction, including without limitation the rights
25
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
26
+ copies of the Software, and to permit persons to whom the Software is
27
+ furnished to do so, subject to the following conditions:
28
+
29
+ The above copyright notice and this permission notice shall be included in all
30
+ copies or substantial portions of the Software.
31
+
32
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
33
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
34
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
35
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
36
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
37
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
38
+ SOFTWARE.
@@ -0,0 +1,550 @@
1
+ /*!
2
+ * @license
3
+ * MIT License
4
+ *
5
+ * Copyright (c) 2023 Chau Tran
6
+ *
7
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ * of this software and associated documentation files (the "Software"), to deal
9
+ * in the Software without restriction, including without limitation the rights
10
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ * copies of the Software, and to permit persons to whom the Software is
12
+ * furnished to do so, subject to the following conditions:
13
+ *
14
+ * The above copyright notice and this permission notice shall be included in all
15
+ * copies or substantial portions of the Software.
16
+ *
17
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
+ * SOFTWARE.
24
+ */
25
+ import { DOCUMENT } from "@angular/common";
26
+ import * as i0 from "@angular/core";
27
+ import { DestroyRef, Directive, ElementRef, Injectable, InjectionToken, afterNextRender, afterRenderEffect, computed, effect, inject, input, isSignal, linkedSignal, signal, untracked } from "@angular/core";
28
+ import { ActivatedRoute, Router } from "@angular/router";
29
+ import { toSignal } from "@angular/core/rxjs-interop";
30
+ function linkedRouteFragment() {
31
+ const route = inject(ActivatedRoute);
32
+ const router = inject(Router);
33
+ const fragment = toSignal(route.fragment);
34
+ const actualFragment = linkedSignal(() => fragment(), ...ngDevMode ? [{ debugName: "actualFragment" }] : /* istanbul ignore next */ []);
35
+ effect(() => {
36
+ const newFragment = actualFragment();
37
+ if (route.snapshot.fragment !== newFragment) {
38
+ const tree = router.createUrlTree([], {
39
+ relativeTo: route,
40
+ fragment: newFragment ?? void 0,
41
+ queryParamsHandling: "preserve"
42
+ });
43
+ router.navigateByUrl(tree, { replaceUrl: true }).catch((error) => {
44
+ console.log(`Cant set fragment ${newFragment}`, error);
45
+ });
46
+ }
47
+ });
48
+ return actualFragment;
49
+ }
50
+ function injectScrollableParentElement(hostElement) {
51
+ function findScrollableParent(el) {
52
+ let current = el.parentElement ?? void 0;
53
+ while (current) {
54
+ const overflowY = getComputedStyle(current).overflowY;
55
+ if (overflowY === "auto" || overflowY === "scroll") return current;
56
+ current = current.parentElement ?? void 0;
57
+ }
58
+ }
59
+ return findScrollableParent(hostElement ?? inject(ElementRef).nativeElement);
60
+ }
61
+ function injectedHeaderHeight(headerSelector, document) {
62
+ const boundingBox = document.querySelector(headerSelector)?.getBoundingClientRect();
63
+ if (!boundingBox) {
64
+ console.warn("No boundingBox found for headerSelector: ", headerSelector);
65
+ return 0;
66
+ }
67
+ return Math.abs(boundingBox.height);
68
+ }
69
+ var NearestAnchorProvider = class NearestAnchorProvider {
70
+ document = inject(DOCUMENT);
71
+ getNearestAnchor(options) {
72
+ const host = options?.hostElement ?? this.document;
73
+ const selector = options?.selector ?? "[id]";
74
+ const offset = (options?.headerOffset ?? 0) + (options?.headerSelector ? injectedHeaderHeight(options.headerSelector, this.document) : 0);
75
+ const anchors = options?.anchors ?? Array.from(host.querySelectorAll(selector));
76
+ if (anchors.length === 0) return;
77
+ const scrollable = options?.scrollable ?? (options?.hostElement ? injectScrollableParentElement(options.hostElement) : void 0);
78
+ const isDocument = !scrollable || scrollable === this.document.documentElement || scrollable === this.document.body;
79
+ const topBoundary = (isDocument ? 0 : scrollable.getBoundingClientRect().top) + offset;
80
+ const viewportBottom = isDocument ? this.document.defaultView?.innerHeight ?? this.document.documentElement.clientHeight : scrollable.getBoundingClientRect().bottom;
81
+ const bottomBoundary = Math.max(topBoundary, viewportBottom - Math.max(0, options?.bottomOffset ?? 0));
82
+ const containedAnchors = anchors.filter((el) => {
83
+ const rect = el.getBoundingClientRect();
84
+ return rect.top >= topBoundary - 1 && rect.bottom <= bottomBoundary + 1;
85
+ });
86
+ if (containedAnchors.length > 0) return containedAnchors.reduce((best, el) => el.getBoundingClientRect().top < best.getBoundingClientRect().top ? el : best).id;
87
+ const threshold = Math.max(0, Math.min(1, options?.activationThreshold ?? 0));
88
+ const triggerLine = topBoundary + (bottomBoundary - topBoundary) * threshold;
89
+ const passedAnchors = anchors.filter((el) => el.getBoundingClientRect().top <= triggerLine + 1);
90
+ if (passedAnchors.length > 0) return passedAnchors.reduce((best, el) => el.getBoundingClientRect().top > best.getBoundingClientRect().top ? el : best).id;
91
+ return anchors.reduce((best, el) => el.getBoundingClientRect().top < best.getBoundingClientRect().top ? el : best).id;
92
+ }
93
+ static ɵfac = i0.ɵɵngDeclareFactory({
94
+ minVersion: "12.0.0",
95
+ version: "22.2.1",
96
+ ngImport: i0,
97
+ type: NearestAnchorProvider,
98
+ deps: [],
99
+ target: i0.ɵɵFactoryTarget.Injectable
100
+ });
101
+ static ɵprov = i0.ɵɵngDeclareInjectable({
102
+ minVersion: "12.0.0",
103
+ version: "22.2.1",
104
+ ngImport: i0,
105
+ type: NearestAnchorProvider
106
+ });
107
+ };
108
+ i0.ɵɵngDeclareClassMetadata({
109
+ minVersion: "12.0.0",
110
+ version: "22.2.1",
111
+ ngImport: i0,
112
+ type: NearestAnchorProvider,
113
+ decorators: [{ type: Injectable }]
114
+ });
115
+ var ScrollService = class ScrollService {
116
+ document = inject(DOCUMENT);
117
+ TOP_OFFSET = 20;
118
+ scroll(anchor, options) {
119
+ const elementId = anchor.startsWith("#") ? anchor.slice(1) : anchor;
120
+ const el = this.document.getElementById(elementId);
121
+ if (!el) return false;
122
+ const scrollable = options?.scrollable ?? this.document.scrollingElement ?? this.document.documentElement;
123
+ const behavior = options?.behavior ?? "instant";
124
+ const ignoreWhenInView = options?.ignoreWhenInView ?? "none";
125
+ const topOffset = options?.topOffset ?? this.TOP_OFFSET;
126
+ const rect = el.getBoundingClientRect();
127
+ const isDocument = scrollable === this.document.documentElement || scrollable === this.document.body;
128
+ const containerTop = isDocument ? 0 : scrollable.getBoundingClientRect().top;
129
+ const viewportHeight = isDocument ? this.document.documentElement.clientHeight : scrollable.clientHeight;
130
+ const isTopInView = rect.top >= containerTop + topOffset - 1 && rect.top < containerTop + viewportHeight;
131
+ const isBottomInView = rect.bottom <= containerTop + viewportHeight && rect.bottom > containerTop;
132
+ if (ignoreWhenInView == "top" && isTopInView || ignoreWhenInView == "full" && isTopInView && isBottomInView || ignoreWhenInView == "always" && (isTopInView || isBottomInView)) return false;
133
+ scrollable.scrollTo({
134
+ top: scrollable.scrollTop + rect.top - containerTop - topOffset,
135
+ behavior
136
+ });
137
+ return true;
138
+ }
139
+ static ɵfac = i0.ɵɵngDeclareFactory({
140
+ minVersion: "12.0.0",
141
+ version: "22.2.1",
142
+ ngImport: i0,
143
+ type: ScrollService,
144
+ deps: [],
145
+ target: i0.ɵɵFactoryTarget.Injectable
146
+ });
147
+ static ɵprov = i0.ɵɵngDeclareInjectable({
148
+ minVersion: "12.0.0",
149
+ version: "22.2.1",
150
+ ngImport: i0,
151
+ type: ScrollService,
152
+ providedIn: "root"
153
+ });
154
+ };
155
+ i0.ɵɵngDeclareClassMetadata({
156
+ minVersion: "12.0.0",
157
+ version: "22.2.1",
158
+ ngImport: i0,
159
+ type: ScrollService,
160
+ decorators: [{
161
+ type: Injectable,
162
+ args: [{ providedIn: "root" }]
163
+ }]
164
+ });
165
+ const defaults = {
166
+ anchorPrefix: "",
167
+ headerSelector: "",
168
+ headerOffset: 0,
169
+ bottomOffset: 0,
170
+ activationThreshold: 0,
171
+ behavior: {
172
+ restoration: "instant",
173
+ interaction: "smooth"
174
+ },
175
+ debounceTime: 500,
176
+ ignoreWhenInView: "none",
177
+ restoreOnDataChange: true,
178
+ preserveOnResize: true
179
+ };
180
+ function resolveMagicScrollOptions(parent, options) {
181
+ return {
182
+ anchorPrefix: options.anchorPrefix ?? parent.anchorPrefix,
183
+ headerSelector: options.headerSelector ?? parent.headerSelector,
184
+ headerOffset: options.headerOffset ?? parent.headerOffset,
185
+ bottomOffset: options.bottomOffset ?? parent.bottomOffset,
186
+ activationThreshold: options.activationThreshold ?? parent.activationThreshold,
187
+ behavior: {
188
+ restoration: options.behavior?.restoration ?? parent.behavior.restoration,
189
+ interaction: options.behavior?.interaction ?? parent.behavior.interaction
190
+ },
191
+ debounceTime: options.debounceTime ?? parent.debounceTime,
192
+ ignoreWhenInView: options.ignoreWhenInView ?? parent.ignoreWhenInView,
193
+ restoreOnDataChange: options.restoreOnDataChange ?? parent.restoreOnDataChange,
194
+ preserveOnResize: options.preserveOnResize ?? parent.preserveOnResize
195
+ };
196
+ }
197
+ const MAGIC_SCROLL_OPTIONS = new InjectionToken("Magic scroll defaults", {
198
+ providedIn: "root",
199
+ factory: () => defaults
200
+ });
201
+ function provideMagicScroll(options = {}) {
202
+ return {
203
+ provide: MAGIC_SCROLL_OPTIONS,
204
+ useFactory: () => resolveMagicScrollOptions(inject(MAGIC_SCROLL_OPTIONS, {
205
+ skipSelf: true,
206
+ optional: true
207
+ }) ?? defaults, options)
208
+ };
209
+ }
210
+ const NO_SCROLL_SOURCE = Symbol("Static, already rendered data");
211
+ function readScrollSource(source) {
212
+ if (source === NO_SCROLL_SOURCE) return {
213
+ ready: true,
214
+ data: source
215
+ };
216
+ let data = source;
217
+ while (isSignal(data)) data = data();
218
+ if (data !== null && typeof data === "object") {
219
+ const candidate = data;
220
+ if (typeof candidate.isLoading === "function") {
221
+ if (candidate.isLoading()) return {
222
+ ready: false,
223
+ data: void 0
224
+ };
225
+ if ("value" in data && typeof data.value === "function") {
226
+ const resource = data;
227
+ data = resource.hasValue && !resource.hasValue() ? void 0 : resource.value();
228
+ } else if (typeof candidate.data === "function") data = candidate.data();
229
+ }
230
+ }
231
+ return {
232
+ ready: data !== void 0 && data !== null,
233
+ data
234
+ };
235
+ }
236
+ const SCROLL_KEYS = /* @__PURE__ */ new Set([
237
+ "ArrowUp",
238
+ "ArrowDown",
239
+ "PageUp",
240
+ "PageDown",
241
+ "Home",
242
+ "End",
243
+ " ",
244
+ "Spacebar",
245
+ "Space"
246
+ ]);
247
+ function isEditableTarget(target) {
248
+ if (!target || !(target instanceof Element)) return false;
249
+ const tagName = target.tagName.toLowerCase();
250
+ if (tagName === "input" || tagName === "textarea" || tagName === "select") return true;
251
+ const editableValue = target.closest("[contenteditable]")?.getAttribute("contenteditable")?.toLowerCase();
252
+ return Boolean(target.isContentEditable || target.closest("input, textarea, select") || editableValue === "" || editableValue === "true" || editableValue === "plaintext-only");
253
+ }
254
+ var MagicScrollDirective = class MagicScrollDirective {
255
+ scrollSource = input(NO_SCROLL_SOURCE, {
256
+ ...ngDevMode ? { debugName: "scrollSource" } : /* istanbul ignore next */ {},
257
+ transform: (value) => value
258
+ });
259
+ scrollOptions = input({}, ...ngDevMode ? [{ debugName: "scrollOptions" }] : /* istanbul ignore next */ []);
260
+ defaults = inject(MAGIC_SCROLL_OPTIONS);
261
+ options = computed(() => resolveMagicScrollOptions(this.defaults, this.scrollOptions()), ...ngDevMode ? [{ debugName: "options" }] : /* istanbul ignore next */ []);
262
+ document = inject(DOCUMENT);
263
+ host = inject(ElementRef).nativeElement;
264
+ service = inject(ScrollService);
265
+ nearest = inject(NearestAnchorProvider);
266
+ fragment = linkedRouteFragment();
267
+ initialAnchor = inject(ActivatedRoute).snapshot.fragment;
268
+ measuredHeaderHeight = signal(0, ...ngDevMode ? [{ debugName: "measuredHeaderHeight" }] : /* istanbul ignore next */ []);
269
+ liveAnchor = signal(null, ...ngDevMode ? [{ debugName: "liveAnchor" }] : /* istanbul ignore next */ []);
270
+ activeAnchor = this.fragment.asReadonly();
271
+ headerHeight = this.measuredHeaderHeight.asReadonly();
272
+ offset = computed(() => this.headerHeight() + this.options().headerOffset, ...ngDevMode ? [{ debugName: "offset" }] : /* istanbul ignore next */ []);
273
+ scrollRevision = signal(0, ...ngDevMode ? [{ debugName: "scrollRevision" }] : /* istanbul ignore next */ []);
274
+ initialized = false;
275
+ userInterrupted = false;
276
+ target;
277
+ timer;
278
+ constructor() {
279
+ const destroyRef = inject(DestroyRef);
280
+ afterNextRender(() => {
281
+ this.refreshTarget();
282
+ this.document.defaultView?.addEventListener("resize", this.onResize);
283
+ });
284
+ destroyRef.onDestroy(() => {
285
+ this.detachListeners();
286
+ this.document.defaultView?.removeEventListener("resize", this.onResize);
287
+ clearTimeout(this.timer);
288
+ });
289
+ afterRenderEffect((onCleanup) => {
290
+ const selector = this.options().headerSelector;
291
+ const header = selector ? this.document.querySelector(selector) : null;
292
+ const measure = () => {
293
+ const height = header?.getBoundingClientRect().height ?? 0;
294
+ if (height !== this.headerHeight()) {
295
+ this.measuredHeaderHeight.set(height);
296
+ if (this.options().preserveOnResize) this.preserve();
297
+ }
298
+ };
299
+ untracked(measure);
300
+ if (header) {
301
+ const observer = new ResizeObserver(measure);
302
+ observer.observe(header);
303
+ onCleanup(() => observer.disconnect());
304
+ }
305
+ });
306
+ afterRenderEffect(() => {
307
+ const source = this.scrollSource();
308
+ if (!readScrollSource(source).ready) return;
309
+ untracked(() => {
310
+ if (!this.initialized) {
311
+ this.initialized = true;
312
+ if (!this.userInterrupted) this.execute(this.initialAnchor, { behavior: this.options().behavior.restoration });
313
+ else this.liveAnchor.set(this.calculateNearestAnchor() ?? null);
314
+ } else if (source !== NO_SCROLL_SOURCE && this.options().restoreOnDataChange) this.preserve("top");
315
+ });
316
+ });
317
+ effect(() => {
318
+ const frag = this.fragment();
319
+ untracked(() => {
320
+ this.liveAnchor.set(frag);
321
+ });
322
+ });
323
+ effect(() => {
324
+ if (!this.scrollRevision()) return;
325
+ const anchor = this.calculateNearestAnchor();
326
+ if (anchor) this.fragment.set(anchor);
327
+ });
328
+ }
329
+ scrollTo(anchor, options = {}) {
330
+ const executed = this.execute(anchor, {
331
+ behavior: this.options().behavior.interaction,
332
+ ignoreWhenInView: this.options().ignoreWhenInView,
333
+ ...options
334
+ });
335
+ if (executed) {
336
+ const clean = anchor.replace(/^#/, "");
337
+ this.liveAnchor.set(clean);
338
+ this.fragment.set(clean);
339
+ }
340
+ return executed;
341
+ }
342
+ anchors() {
343
+ const prefix = this.options().anchorPrefix;
344
+ return Array.from(this.host.querySelectorAll("[id]")).filter((el) => !!el.id && (el.hasAttribute("data-scroll-anchor") || el.id.startsWith(prefix)) && el.closest("[magicScroll]") === this.host);
345
+ }
346
+ scrollable() {
347
+ const overflow = getComputedStyle(this.host).overflowY;
348
+ const container = overflow === "auto" || overflow === "scroll" ? this.host : injectScrollableParentElement(this.host);
349
+ return container === this.document.documentElement || container === this.document.body ? void 0 : container;
350
+ }
351
+ calculateNearestAnchor() {
352
+ return this.nearest.getNearestAnchor({
353
+ hostElement: this.host,
354
+ anchors: this.anchors(),
355
+ scrollable: this.scrollable(),
356
+ headerOffset: this.offset(),
357
+ bottomOffset: this.options().bottomOffset,
358
+ activationThreshold: this.options().activationThreshold
359
+ });
360
+ }
361
+ execute(anchor, options) {
362
+ if (!anchor || !this.anchors().some((el) => el.id === anchor.replace(/^#/, ""))) return false;
363
+ return this.service.scroll(anchor, {
364
+ scrollable: this.scrollable(),
365
+ topOffset: this.offset(),
366
+ ...options
367
+ });
368
+ }
369
+ preserve(ignoreWhenInView = "none") {
370
+ if (this.initialized) this.execute(this.liveAnchor(), {
371
+ behavior: "instant",
372
+ ignoreWhenInView
373
+ });
374
+ }
375
+ refreshTarget() {
376
+ const target = this.scrollable() ?? this.document;
377
+ if (target !== this.target) {
378
+ this.detachListeners();
379
+ this.target = target;
380
+ this.attachListeners(target);
381
+ }
382
+ }
383
+ attachListeners(target) {
384
+ target.addEventListener("scroll", this.onScroll);
385
+ target.addEventListener("wheel", this.onUserIntent, { passive: true });
386
+ target.addEventListener("touchstart", this.onUserIntent, { passive: true });
387
+ target.addEventListener("touchmove", this.onUserIntent, { passive: true });
388
+ target.addEventListener("keydown", this.onKeyDown);
389
+ this.document.addEventListener("keydown", this.onKeyDown);
390
+ }
391
+ detachListeners() {
392
+ if (!this.target) return;
393
+ this.target.removeEventListener("scroll", this.onScroll);
394
+ this.target.removeEventListener("wheel", this.onUserIntent);
395
+ this.target.removeEventListener("touchstart", this.onUserIntent);
396
+ this.target.removeEventListener("touchmove", this.onUserIntent);
397
+ this.target.removeEventListener("keydown", this.onKeyDown);
398
+ this.document.removeEventListener("keydown", this.onKeyDown);
399
+ }
400
+ onUserIntent = () => {
401
+ this.userInterrupted = true;
402
+ };
403
+ onKeyDown = (event) => {
404
+ if (!(event instanceof KeyboardEvent)) return;
405
+ if (isEditableTarget(event.target)) return;
406
+ if (!SCROLL_KEYS.has(event.key)) return;
407
+ const targetEl = event.target;
408
+ const scrollable = this.scrollable();
409
+ if (!targetEl || targetEl === this.document.body || targetEl === this.document.documentElement || (scrollable ? scrollable === targetEl || scrollable.contains(targetEl) : true)) this.userInterrupted = true;
410
+ };
411
+ onScroll = () => {
412
+ if (!this.initialized) return;
413
+ const anchor = this.calculateNearestAnchor();
414
+ if (anchor) this.liveAnchor.set(anchor);
415
+ clearTimeout(this.timer);
416
+ this.timer = setTimeout(() => this.scrollRevision.update((revision) => revision + 1), this.options().debounceTime);
417
+ };
418
+ onResize = () => {
419
+ this.refreshTarget();
420
+ if (this.options().preserveOnResize) this.preserve();
421
+ };
422
+ static ɵfac = i0.ɵɵngDeclareFactory({
423
+ minVersion: "12.0.0",
424
+ version: "22.2.1",
425
+ ngImport: i0,
426
+ type: MagicScrollDirective,
427
+ deps: [],
428
+ target: i0.ɵɵFactoryTarget.Directive
429
+ });
430
+ static ɵdir = i0.ɵɵngDeclareDirective({
431
+ minVersion: "17.1.0",
432
+ version: "22.2.1",
433
+ type: MagicScrollDirective,
434
+ isStandalone: true,
435
+ selector: "[magicScroll]",
436
+ inputs: {
437
+ scrollSource: {
438
+ classPropertyName: "scrollSource",
439
+ publicName: "scrollSource",
440
+ isSignal: true,
441
+ isRequired: false,
442
+ transformFunction: null
443
+ },
444
+ scrollOptions: {
445
+ classPropertyName: "scrollOptions",
446
+ publicName: "scrollOptions",
447
+ isSignal: true,
448
+ isRequired: false,
449
+ transformFunction: null
450
+ }
451
+ },
452
+ host: { properties: { "attr.magicScroll": "\"\"" } },
453
+ providers: [NearestAnchorProvider],
454
+ exportAs: ["magicScroll"],
455
+ ngImport: i0
456
+ });
457
+ };
458
+ i0.ɵɵngDeclareClassMetadata({
459
+ minVersion: "12.0.0",
460
+ version: "22.2.1",
461
+ ngImport: i0,
462
+ type: MagicScrollDirective,
463
+ decorators: [{
464
+ type: Directive,
465
+ args: [{
466
+ selector: "[magicScroll]",
467
+ exportAs: "magicScroll",
468
+ providers: [NearestAnchorProvider],
469
+ host: { "[attr.magicScroll]": "\"\"" }
470
+ }]
471
+ }],
472
+ ctorParameters: () => [],
473
+ propDecorators: {
474
+ scrollSource: [{
475
+ type: i0.Input,
476
+ args: [{
477
+ isSignal: true,
478
+ alias: "scrollSource",
479
+ required: false
480
+ }]
481
+ }],
482
+ scrollOptions: [{
483
+ type: i0.Input,
484
+ args: [{
485
+ isSignal: true,
486
+ alias: "scrollOptions",
487
+ required: false
488
+ }]
489
+ }]
490
+ }
491
+ });
492
+ var ScrollAnchorDirective = class ScrollAnchorDirective {
493
+ scrollAnchor = input("", ...ngDevMode ? [{ debugName: "scrollAnchor" }] : /* istanbul ignore next */ []);
494
+ host = inject(ElementRef);
495
+ constructor() {
496
+ effect(() => {
497
+ const id = this.scrollAnchor();
498
+ if (id) this.host.nativeElement.id = id;
499
+ });
500
+ }
501
+ static ɵfac = i0.ɵɵngDeclareFactory({
502
+ minVersion: "12.0.0",
503
+ version: "22.2.1",
504
+ ngImport: i0,
505
+ type: ScrollAnchorDirective,
506
+ deps: [],
507
+ target: i0.ɵɵFactoryTarget.Directive
508
+ });
509
+ static ɵdir = i0.ɵɵngDeclareDirective({
510
+ minVersion: "17.1.0",
511
+ version: "22.2.1",
512
+ type: ScrollAnchorDirective,
513
+ isStandalone: true,
514
+ selector: "[scrollAnchor]",
515
+ inputs: { scrollAnchor: {
516
+ classPropertyName: "scrollAnchor",
517
+ publicName: "scrollAnchor",
518
+ isSignal: true,
519
+ isRequired: false,
520
+ transformFunction: null
521
+ } },
522
+ host: { properties: { "attr.data-scroll-anchor": "\"\"" } },
523
+ ngImport: i0
524
+ });
525
+ };
526
+ i0.ɵɵngDeclareClassMetadata({
527
+ minVersion: "12.0.0",
528
+ version: "22.2.1",
529
+ ngImport: i0,
530
+ type: ScrollAnchorDirective,
531
+ decorators: [{
532
+ type: Directive,
533
+ args: [{
534
+ selector: "[scrollAnchor]",
535
+ host: { "[attr.data-scroll-anchor]": "\"\"" }
536
+ }]
537
+ }],
538
+ ctorParameters: () => [],
539
+ propDecorators: { scrollAnchor: [{
540
+ type: i0.Input,
541
+ args: [{
542
+ isSignal: true,
543
+ alias: "scrollAnchor",
544
+ required: false
545
+ }]
546
+ }] }
547
+ });
548
+ export { MagicScrollDirective, ScrollAnchorDirective, provideMagicScroll };
549
+
550
+ //# sourceMappingURL=devzwo-ngx-magic-scroll.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"devzwo-ngx-magic-scroll.mjs","names":[],"sources":["../../../projects/ngx-magic-scroll/src/lib/navigation/linked-route-fragment.ts","../../../projects/ngx-magic-scroll/src/lib/navigation/inject-scrollable-parent.ts","../../../projects/ngx-magic-scroll/src/lib/navigation/inject-header-size.ts","../../../projects/ngx-magic-scroll/src/lib/navigation/nearest-anchor.provider.ts","../../../projects/ngx-magic-scroll/src/lib/navigation/scroll-service.ts","../../../projects/ngx-magic-scroll/src/lib/facade/magic-scroll-options.ts","../../../projects/ngx-magic-scroll/src/lib/facade/scroll-source.ts","../../../projects/ngx-magic-scroll/src/lib/facade/magic-scroll.directive.ts","../../../projects/ngx-magic-scroll/src/lib/facade/scroll-anchor.directive.ts"],"sourcesContent":["import { effect, inject, linkedSignal, WritableSignal } from '@angular/core';\nimport { toSignal } from '@angular/core/rxjs-interop';\nimport { ActivatedRoute, Router } from '@angular/router';\n\n/**\n * Creates an Angular signal synchronized bidirectionally with the URL fragment (#fragment).\n *\n * Reads the current route fragment as a writable signal (WritableSignal).\n * - Reading reacts to URL fragment changes through ActivatedRoute.fragment.\n * - Writing, for example fragmentSignal.set('anchor-id'), asynchronously updates the URL\n * through Router.navigateByUrl with replaceUrl: true. This preserves query parameters\n * and avoids adding a history entry for each scroll update.\n *\n * @returns A WritableSignal<string | null | undefined> linked to the URL fragment.\n * @example\n * ```ts\n * @Component({ ... })\n * export class MyViewComponent {\n * // Initialize the signal\n * protected readonly routeFragment = linkedRouteFragment();\n *\n * onAnchorReached(anchorId: string) {\n * // Update the URL fragment without adding history entries (#anchorId)\n * this.routeFragment.set(anchorId);\n * }\n * }\n * ```\n */\nexport function linkedRouteFragment(): WritableSignal<string | null | undefined> {\n const route = inject(ActivatedRoute);\n const router = inject(Router);\n const fragment = toSignal(route.fragment);\n\n const actualFragment = linkedSignal(() => fragment());\n\n effect(() => {\n const newFragment = actualFragment();\n if (route.snapshot.fragment !== newFragment) {\n const tree = router.createUrlTree([], {\n relativeTo: route,\n fragment: newFragment ?? undefined,\n queryParamsHandling: 'preserve',\n });\n\n router.navigateByUrl(tree, { replaceUrl: true }).catch((error: Error) => {\n console.log(`Cant set fragment ${newFragment}`, error);\n });\n }\n });\n\n return actualFragment;\n}\n","import { ElementRef, inject } from '@angular/core';\n\n/**\n * Finds the closest scrollable ancestor in the DOM.\n *\n * Walks up the DOM tree looking for overflow-y: auto or overflow-y: scroll.\n * Call within an Angular injection context to start at ElementRef.nativeElement,\n * or pass a hostElement explicitly.\n *\n * @param hostElement - Optional starting element. An explicit element takes precedence;\n * otherwise the starting element is obtained by injecting ElementRef<HTMLElement>.\n * @returns The closest scrollable HTMLElement, or undefined if none exists.\n * @example\n * ```ts\n * // Within an injection context (for example a directive or component constructor):\n * const scrollParent = injectScrollableParentElement();\n *\n * // Outside an injection context:\n * const scrollParent = injectScrollableParentElement(myHtmlElement);\n * ```\n */\nexport function injectScrollableParentElement(\n hostElement?: HTMLElement | null,\n): HTMLElement | undefined {\n function findScrollableParent(el: HTMLElement): HTMLElement | undefined {\n let current = el.parentElement ?? undefined;\n while (current) {\n const overflowY = getComputedStyle(current).overflowY;\n if (\n overflowY === 'auto' ||\n overflowY === 'scroll' /**&& current.scrollHeight > current.clientHeight **/\n ) {\n return current;\n }\n current = current.parentElement ?? undefined;\n }\n return undefined;\n }\n\n return findScrollableParent(\n hostElement ?? (inject(ElementRef<HTMLElement>).nativeElement as HTMLElement),\n );\n}\n","/**\n * Measures the height of a header selected within the supplied document.\n * Used to calculate scroll and anchor offsets so a fixed or sticky header does not\n * cover the scrolled content.\n *\n * @param headerSelector - Header CSS selector, such as '.header' or 'app-header'.\n * @param document - Document instance in which to search, for example injected through DOCUMENT.\n * @returns The absolute header height in pixels, or 0 if the element is not found.\n * @example\n * ```ts\n * const document = inject(DOCUMENT);\n * const height = injectedHeaderHeight('.header', document);\n * ```\n */\nexport function injectedHeaderHeight(headerSelector: string, document: Document): number {\n const boundingBox = document.querySelector<HTMLElement>(headerSelector)?.getBoundingClientRect();\n if (!boundingBox) {\n console.warn('No boundingBox found for headerSelector: ', headerSelector);\n return 0;\n }\n\n return Math.abs(boundingBox.height);\n}\n","import { DOCUMENT } from '@angular/common';\nimport { inject, Injectable } from '@angular/core';\nimport { injectScrollableParentElement } from './inject-scrollable-parent';\nimport { injectedHeaderHeight } from './inject-header-size';\n\n/**\n * Options for finding the nearest anchor.\n */\nexport interface NearestAnchorOptions {\n /** Explicit scroll container, including a host that is itself scrollable. */\n scrollable?: HTMLElement;\n /** Preselected anchor elements (e.g. scoped, explicit anchors in the facade). */\n anchors?: readonly HTMLElement[];\n /**\n * Optional host element within which to find anchor elements.\n * Defaults to searching the entire Document.\n */\n hostElement?: HTMLElement;\n /**\n * CSS selector for eligible anchors, for example '[id^=\"item-card-\"]'.\n * Defaults to '[id]'.\n */\n selector?: string;\n /**\n * Static top offset, in pixels, such as a fixed gap or padding.\n */\n headerOffset?: number;\n /**\n * CSS selector for a fixed or sticky header, for example '.header'.\n * Its measured height is added to the offset so covered elements are not selected\n * as the topmost visible anchor.\n */\n headerSelector?: string;\n /**\n * Static bottom offset, in pixels, such as a sticky footer gap or bottom margin.\n */\n bottomOffset?: number;\n /**\n * Relative activation threshold (0.0 to 1.0) defining the trigger line within the visible reading area.\n */\n activationThreshold?: number;\n}\n\n/**\n * Finds the anchor representing the currently read section based on full containment and activation boundaries.\n *\n * Supports scroll-spy behavior to identify the current section while scrolling and\n * synchronize the URL fragment. A section is activated immediately when fully visible in the\n * viewport below sticky headers, or remains active while scrolling through its content until\n * the next section crosses the activation boundary or becomes fully visible.\n *\n * @remarks\n * This service does not use providedIn: 'root'. Register it in application or component\n * providers when using it internally. The facade provides its own instance.\n */\n@Injectable()\nexport class NearestAnchorProvider {\n private readonly document = inject(DOCUMENT);\n\n /**\n * Calculates the ID of the active anchor based on scroll position and visible area boundaries.\n *\n * 1. Evaluates all eligible anchors within the host or document.\n * 2. Determines the visible reading area (`topBoundary = scrollableTop + headerOffset + headerHeight`, `bottomBoundary = (containerBottom | viewportHeight) - bottomOffset`).\n * 3. Prioritizes fully contained anchors (`top >= topBoundary - 1` and `bottom <= bottomBoundary + 1`), selecting the topmost one.\n * 4. Falls back to the anchor that crossed `triggerLine` most recently (`top <= triggerLine + 1`).\n * 5. Falls back to the first anchor if no anchor has crossed the boundary yet.\n *\n * @param options - Host element, selector, scroll container and header-offset settings.\n * @returns The active anchor's element ID, or undefined if no eligible element exists.\n * @example\n * ```ts\n * const nearestId = nearestAnchorProvider.getNearestAnchor({\n * hostElement: listContainer,\n * selector: '[id^=\"card-\"]',\n * headerSelector: '.app-header',\n * bottomOffset: 40\n * });\n * ```\n */\n public getNearestAnchor(options?: NearestAnchorOptions): string | undefined {\n const host = options?.hostElement ?? this.document;\n const selector = options?.selector ?? '[id]';\n const offset =\n (options?.headerOffset ?? 0) +\n (options?.headerSelector ? injectedHeaderHeight(options.headerSelector, this.document) : 0);\n\n // Collects all HTML elements with an id – these are our potential anchor targets\n const anchors = options?.anchors ?? Array.from(host.querySelectorAll<HTMLElement>(selector));\n if (anchors.length === 0) {\n return undefined;\n }\n\n const scrollable =\n options?.scrollable ??\n (options?.hostElement ? injectScrollableParentElement(options.hostElement) : undefined);\n const isDocument =\n !scrollable ||\n scrollable === this.document.documentElement ||\n scrollable === this.document.body;\n const topBoundary = (isDocument ? 0 : scrollable.getBoundingClientRect().top) + offset;\n const viewportBottom = isDocument\n ? (this.document.defaultView?.innerHeight ?? this.document.documentElement.clientHeight)\n : scrollable.getBoundingClientRect().bottom;\n const bottomBoundary = Math.max(\n topBoundary,\n viewportBottom - Math.max(0, options?.bottomOffset ?? 0),\n );\n\n // 1. Check for fully contained anchors (entire element inside visible reading area)\n const containedAnchors = anchors.filter((el) => {\n const rect = el.getBoundingClientRect();\n return rect.top >= topBoundary - 1 && rect.bottom <= bottomBoundary + 1;\n });\n\n if (containedAnchors.length > 0) {\n // Topmost fully visible anchor\n const topmostContained = containedAnchors.reduce((best, el) =>\n el.getBoundingClientRect().top < best.getBoundingClientRect().top ? el : best,\n );\n return topmostContained.id;\n }\n\n // 2. Reading line fallback: Anchor that crossed triggerLine most recently\n const threshold = Math.max(0, Math.min(1, options?.activationThreshold ?? 0));\n const triggerLine = topBoundary + (bottomBoundary - topBoundary) * threshold;\n const passedAnchors = anchors.filter((el) => el.getBoundingClientRect().top <= triggerLine + 1);\n\n if (passedAnchors.length > 0) {\n // Pick the anchor that crossed the trigger line most recently (highest top <= triggerLine)\n const active = passedAnchors.reduce((best, el) =>\n el.getBoundingClientRect().top > best.getBoundingClientRect().top ? el : best,\n );\n return active.id;\n }\n\n // 3. Before any anchor has reached the boundary, select the first anchor\n const first = anchors.reduce((best, el) =>\n el.getBoundingClientRect().top < best.getBoundingClientRect().top ? el : best,\n );\n return first.id;\n }\n}\n","import { inject, Injectable } from '@angular/core';\nimport { DOCUMENT } from '@angular/common';\n\n/**\n * Options for a scroll operation performed by ScrollService.\n */\nexport interface ScrollOptions {\n /**\n * Scrollable container. Defaults to the document's scrolling element.\n */\n scrollable?: HTMLElement;\n /**\n * Scroll behavior: 'instant' for an immediate jump, 'smooth' for animation,\n * or 'auto' to follow the browser's CSS scroll behavior. Defaults to 'instant'.\n */\n behavior?: ScrollBehavior;\n /**\n * Visibility condition under which scrolling is skipped:\n * - 'none': Always scroll (default).\n * - 'top': Skip when the element's top edge is visible.\n * - 'full': Skip when the entire element is visible.\n * - 'always': Skip when either the top or bottom edge is visible.\n */\n ignoreWhenInView?: 'none' | 'top' | 'full' | 'always';\n /**\n * Additional top offset for the target, in pixels, for example for a header or padding.\n * Defaults to 20 pixels.\n */\n topOffset?: number;\n}\n\n/**\n * Central service for scrolling to DOM elements and anchors.\n *\n * Supports explicit scroll containers or document scrolling, configurable header offsets,\n * visibility checks to avoid unnecessary movement, and smooth or instant scrolling.\n */\n@Injectable({\n providedIn: 'root',\n})\nexport class ScrollService {\n private readonly document = inject<Document>(DOCUMENT);\n private readonly TOP_OFFSET = 20;\n\n /**\n * Scrolls to the element identified by its ID.\n *\n * @param anchor - Target HTML element ID, with or without a leading #.\n * @param options - Scroll container, behavior, offset and visibility settings.\n * @returns True when the target exists and scrolling is initiated; otherwise false.\n * @example\n * ```ts\n * // Simple scrolling\n * scrollService.scroll('section-details');\n *\n * // With options\n * scrollService.scroll('card-123', {\n * scrollable: scrollContainerElement,\n * behavior: 'smooth',\n * topOffset: 80,\n * ignoreWhenInView: 'top'\n * });\n * ```\n */\n scroll(anchor: string, options?: ScrollOptions): boolean {\n const elementId = anchor.startsWith('#') ? anchor.slice(1) : anchor;\n const el = this.document.getElementById(elementId);\n\n if (!el) {\n return false;\n }\n\n const scrollable =\n options?.scrollable ??\n (this.document.scrollingElement as HTMLElement | null) ??\n this.document.documentElement;\n const behavior = options?.behavior ?? 'instant';\n const ignoreWhenInView = options?.ignoreWhenInView ?? 'none';\n const topOffset = options?.topOffset ?? this.TOP_OFFSET;\n\n const rect = el.getBoundingClientRect();\n const isDocument =\n scrollable === this.document.documentElement || scrollable === this.document.body;\n const containerTop = isDocument ? 0 : scrollable.getBoundingClientRect().top;\n const viewportHeight = isDocument\n ? this.document.documentElement.clientHeight\n : scrollable.clientHeight;\n const isTopInView =\n rect.top >= containerTop + topOffset - 1 && rect.top < containerTop + viewportHeight;\n const isBottomInView =\n rect.bottom <= containerTop + viewportHeight && rect.bottom > containerTop;\n\n if (\n (ignoreWhenInView == 'top' && isTopInView) ||\n (ignoreWhenInView == 'full' && isTopInView && isBottomInView) ||\n (ignoreWhenInView == 'always' && (isTopInView || isBottomInView))\n ) {\n return false;\n }\n\n // One operation keeps offsets accurate during smooth scrolling and only moves the selected container.\n scrollable.scrollTo({\n top: scrollable.scrollTop + rect.top - containerTop - topOffset,\n behavior,\n });\n\n return true;\n }\n}\n","import { inject, InjectionToken, Provider } from '@angular/core';\nimport { ScrollOptions } from '../navigation/scroll-service';\n\n/** Defaults for an application or overrides for one `magicScroll` region. */\nexport interface MagicScrollOptions {\n /** All descendant IDs participate when empty. Explicit `scrollAnchor`s also participate. */\n anchorPrefix?: string;\n /** Selector for a fixed/sticky header whose height is measured automatically. */\n headerSelector?: string;\n /** Gap below the header, or the complete top offset when no header is selected. */\n headerOffset?: number;\n /** Bottom offset in pixels to adjust the active reading boundary from the bottom. */\n bottomOffset?: number;\n /** Relative activation threshold (0.0 to 1.0) defining the trigger line within the visible reading area. */\n activationThreshold?: number;\n /** Restoration and deliberate user navigation have separate defaults. */\n behavior?: {\n restoration?: ScrollBehavior;\n interaction?: ScrollBehavior;\n };\n debounceTime?: number;\n ignoreWhenInView?: ScrollOptions['ignoreWhenInView'];\n /** Keep the current anchor visible after later data updates. Defaults to true. */\n restoreOnDataChange?: boolean;\n /** Preserve the current anchor on window resize and measured header-height changes. */\n preserveOnResize?: boolean;\n}\n\nexport interface ResolvedMagicScrollOptions {\n anchorPrefix: string;\n headerSelector: string;\n headerOffset: number;\n bottomOffset: number;\n activationThreshold: number;\n behavior: { restoration: ScrollBehavior; interaction: ScrollBehavior };\n debounceTime: number;\n ignoreWhenInView: NonNullable<ScrollOptions['ignoreWhenInView']>;\n restoreOnDataChange: boolean;\n preserveOnResize: boolean;\n}\n\nconst defaults: ResolvedMagicScrollOptions = {\n anchorPrefix: '',\n headerSelector: '',\n headerOffset: 0,\n bottomOffset: 0,\n activationThreshold: 0,\n behavior: { restoration: 'instant', interaction: 'smooth' },\n debounceTime: 500,\n ignoreWhenInView: 'none',\n restoreOnDataChange: true,\n preserveOnResize: true,\n};\n\nexport function resolveMagicScrollOptions(\n parent: ResolvedMagicScrollOptions,\n options: MagicScrollOptions,\n): ResolvedMagicScrollOptions {\n return {\n anchorPrefix: options.anchorPrefix ?? parent.anchorPrefix,\n headerSelector: options.headerSelector ?? parent.headerSelector,\n headerOffset: options.headerOffset ?? parent.headerOffset,\n bottomOffset: options.bottomOffset ?? parent.bottomOffset,\n activationThreshold: options.activationThreshold ?? parent.activationThreshold,\n behavior: {\n restoration: options.behavior?.restoration ?? parent.behavior.restoration,\n interaction: options.behavior?.interaction ?? parent.behavior.interaction,\n },\n debounceTime: options.debounceTime ?? parent.debounceTime,\n ignoreWhenInView: options.ignoreWhenInView ?? parent.ignoreWhenInView,\n restoreOnDataChange: options.restoreOnDataChange ?? parent.restoreOnDataChange,\n preserveOnResize: options.preserveOnResize ?? parent.preserveOnResize,\n };\n}\n\nexport const MAGIC_SCROLL_OPTIONS = new InjectionToken<ResolvedMagicScrollOptions>(\n 'Magic scroll defaults',\n { providedIn: 'root', factory: () => defaults },\n);\n\n/**\n * Register defaults globally or on a component. Child providers inherit unspecified options.\n * Per-region `scrollOptions` and per-call `scrollTo` options take precedence.\n *\n * @example\n * provideMagicScroll({ anchorPrefix: 'project-', behavior: { interaction: 'smooth' } })\n */\nexport function provideMagicScroll(options: MagicScrollOptions = {}): Provider {\n return {\n provide: MAGIC_SCROLL_OPTIONS,\n useFactory: () =>\n resolveMagicScrollOptions(\n inject(MAGIC_SCROLL_OPTIONS, { skipSelf: true, optional: true }) ?? defaults,\n options,\n ),\n };\n}\n","import { isSignal, Signal } from '@angular/core';\nimport { ScrollDataSource } from '../navigation/scroll-data-source';\n\n/** Structural Angular resource contract; no dependency on a data-fetching provider. */\nexport interface ScrollResource {\n readonly value: () => unknown;\n readonly isLoading: () => boolean;\n readonly hasValue?: () => boolean;\n}\n\n/**\n * Pass a signal (also computed/input/model signals), a resource/rxResource, or\n * reactive data()/isLoading() getters. Plain input values are supported too.\n * For signal forms pass the field's value signal, e.g. `form().value`.\n * Supabase data and loading signals can use the neutral ScrollDataSource contract.\n */\nexport type ScrollSource =\n | Signal<unknown>\n | ScrollResource\n | ScrollDataSource\n | object\n | string\n | number\n | boolean\n | null\n | undefined;\n\nexport const NO_SCROLL_SOURCE = Symbol('Static, already rendered data');\n\n/** Internal readiness adapter. null/undefined wait; [], 0, false and '' are ready. */\nexport function readScrollSource(source: ScrollSource | typeof NO_SCROLL_SOURCE): {\n ready: boolean;\n data: unknown;\n} {\n if (source === NO_SCROLL_SOURCE) return { ready: true, data: source };\n let data: unknown = source;\n while (isSignal(data)) data = data();\n if (data !== null && typeof data === 'object') {\n // Query results may be proxies whose `has` trap reflects the current value.\n // Read the loading getter directly: `isLoading in source` can be false when idle.\n const candidate = data as { isLoading?: unknown; data?: unknown };\n if (typeof candidate.isLoading === 'function') {\n if (candidate.isLoading()) return { ready: false, data: undefined };\n if ('value' in data && typeof data.value === 'function') {\n const resource = data as ScrollResource;\n // Reading an Angular resource's value in an error state can throw.\n data = resource.hasValue && !resource.hasValue() ? undefined : resource.value();\n } else if (typeof candidate.data === 'function') {\n data = candidate.data();\n }\n }\n }\n return { ready: data !== undefined && data !== null, data };\n}\n","import { DOCUMENT } from '@angular/common';\nimport {\n afterNextRender,\n afterRenderEffect,\n computed,\n DestroyRef,\n Directive,\n effect,\n ElementRef,\n inject,\n input,\n signal,\n untracked,\n} from '@angular/core';\nimport { ActivatedRoute } from '@angular/router';\nimport { linkedRouteFragment } from '../navigation/linked-route-fragment';\nimport { injectScrollableParentElement } from '../navigation/inject-scrollable-parent';\nimport { NearestAnchorProvider } from '../navigation/nearest-anchor.provider';\nimport { ScrollOptions, ScrollService } from '../navigation/scroll-service';\nimport {\n MAGIC_SCROLL_OPTIONS,\n MagicScrollOptions,\n resolveMagicScrollOptions,\n} from './magic-scroll-options';\nimport { NO_SCROLL_SOURCE, readScrollSource, ScrollSource } from './scroll-source';\n\n/**\n * Per-action scroll options for programmatic navigation via {@link MagicScrollDirective.scrollTo}.\n * Top offsets and container scoping are resolved automatically by the directive facade.\n */\nexport type MagicScrollToOptions = Pick<\n ScrollOptions,\n 'behavior' | 'topOffset' | 'ignoreWhenInView'\n>;\n\n/**\n * Standard keyboard navigation keys that manipulate viewport scroll position.\n * Used by {@link MagicScrollDirective} to detect manual user scroll intent and cancel\n * pending automatic initial restorations prior to asynchronous data loading readiness.\n */\nconst SCROLL_KEYS = new Set([\n 'ArrowUp',\n 'ArrowDown',\n 'PageUp',\n 'PageDown',\n 'Home',\n 'End',\n ' ',\n 'Spacebar',\n 'Space',\n]);\n\n/**\n * Determines whether a keyboard event target is an interactive or editable text control.\n * Ensures typing and navigating within input fields, textareas, dropdowns, and contenteditable\n * areas do not mistakenly cancel pending initial scroll restoration.\n */\nfunction isEditableTarget(target: EventTarget | null): boolean {\n if (!target || !(target instanceof Element)) return false;\n const tagName = target.tagName.toLowerCase();\n if (tagName === 'input' || tagName === 'textarea' || tagName === 'select') return true;\n const editableHost = target.closest('[contenteditable]');\n const editableValue = editableHost?.getAttribute('contenteditable')?.toLowerCase();\n return Boolean(\n (target as HTMLElement).isContentEditable ||\n target.closest('input, textarea, select') ||\n editableValue === '' ||\n editableValue === 'true' ||\n editableValue === 'plaintext-only',\n );\n}\n\n/**\n * Complete facade directive coordinating anchor scrolling, two-tier route synchronization,\n * user-intent cancellation, data readiness restoration, and layout/data position preservation.\n *\n * @remarks\n * ### Architectural Pillars:\n * 1. **Two-Tier Anchor State Model**:\n * - `liveAnchor`: Immediate per-scroll evaluation representing the visible section currently in view.\n * Used as the source of truth for immediate data and layout realignments.\n * - `fragment` / `activeAnchor`: Debounced (default 500ms) URL router synchronization preventing browser\n * history thrashing during continuous scrolling.\n * 2. **User Intent Detection & Cancellation**:\n * - Captures manual user gestures (`wheel`, `touchstart`, `touchmove`, navigation `keydown`) occurring prior\n * to asynchronous `scrollSource` readiness.\n * - Invalidates pending delayed initial restorations so conscious user navigation is never overridden.\n * - Safely excludes editable form controls (`<input>`, `<textarea>`, `contenteditable`).\n * 3. **Reactive Render Pipeline & Lifecycle Coordination**:\n * - Sequenced `afterRenderEffect` execution blocks guarantee sticky header measurement and `ResizeObserver`\n * monitoring are active before initial fragment restoration and data preservation execute.\n * 4. **Preservation & Realignment Engine**:\n * - Automatic realignments (`preserve('top')`) on data updates and container/header resizes based on the live active section.\n * 5. **Container & Anchor Scoping**:\n * - Automatic scroll container resolution (window vs scrollable element) and hierarchical anchor ownership isolation.\n *\n * @example\n * ```html\n * <div magicScroll #scroll=\"magicScroll\" [scrollSource]=\"projects\">\n * <section id=\"project-1\">...</section>\n * <section id=\"project-2\">...</section>\n * </div>\n * <button (click)=\"scroll.scrollTo('project-2')\">Go to Project 2</button>\n * ```\n */\n@Directive({\n selector: '[magicScroll]',\n exportAs: 'magicScroll',\n providers: [NearestAnchorProvider],\n host: { '[attr.magicScroll]': '\"\"' },\n})\nexport class MagicScrollDirective {\n /**\n * Asynchronous data source or signal determining scroll readiness.\n * - When omitted (`NO_SCROLL_SOURCE`), initial restoration executes on the initial rendered DOM.\n * - When provided, initial restoration waits until `readScrollSource(source).ready === true`.\n * Subsequent ready data updates trigger automatic position preservation when `restoreOnDataChange` is enabled.\n */\n readonly scrollSource = input<ScrollSource | typeof NO_SCROLL_SOURCE, ScrollSource>(\n NO_SCROLL_SOURCE,\n { transform: (value) => value },\n );\n\n /** Configuration overrides merged with global `provideMagicScroll` options. */\n readonly scrollOptions = input<MagicScrollOptions>({});\n\n private readonly defaults = inject(MAGIC_SCROLL_OPTIONS);\n private readonly options = computed(() =>\n resolveMagicScrollOptions(this.defaults, this.scrollOptions()),\n );\n private readonly document = inject(DOCUMENT);\n private readonly host = inject<ElementRef<HTMLElement>>(ElementRef).nativeElement;\n private readonly service = inject(ScrollService);\n private readonly nearest = inject(NearestAnchorProvider);\n\n /** Bidirectional route fragment synchronization signal (debounced URL writer and listener). */\n private readonly fragment = linkedRouteFragment();\n\n /** Initial route URL fragment snapshot captured upon directive instantiation. */\n private readonly initialAnchor = inject(ActivatedRoute).snapshot.fragment;\n\n /** Dynamically measured header height via ResizeObserver. */\n private readonly measuredHeaderHeight = signal(0);\n\n /**\n * Real-time visible section identifier updated per scroll event.\n * Serves as the source of truth for immediate data and layout realignments (`preserve`),\n * decoupling preservation from the debounced URL fragment signal.\n */\n private readonly liveAnchor = signal<string | null | undefined>(null);\n\n /** Current URL anchor, suitable for active-navigation highlighting. */\n readonly activeAnchor = this.fragment.asReadonly();\n\n /** Measured header height, useful for sticky companion panels. */\n readonly headerHeight = this.measuredHeaderHeight.asReadonly();\n\n /** Complete effective top offset, including header height and configured gap. */\n readonly offset = computed(() => this.headerHeight() + this.options().headerOffset);\n\n /** Monotonically increasing revision counter triggering debounced URL fragment updates. */\n private readonly scrollRevision = signal(0);\n\n /** Flag indicating whether the initial restoration phase has been executed. */\n private initialized = false;\n\n /**\n * Flag indicating whether manual user interaction (wheel, touch, or navigation keys) occurred\n * before asynchronous data loading became ready. When true, delayed initial restoration is skipped.\n */\n private userInterrupted = false;\n\n private target?: EventTarget;\n private timer?: ReturnType<typeof setTimeout>;\n\n constructor() {\n const destroyRef = inject(DestroyRef);\n afterNextRender(() => {\n this.refreshTarget();\n this.document.defaultView?.addEventListener('resize', this.onResize);\n });\n destroyRef.onDestroy(() => {\n this.detachListeners();\n this.document.defaultView?.removeEventListener('resize', this.onResize);\n clearTimeout(this.timer);\n });\n\n // Phase 1: Header measurement & ResizeObserver tracking.\n // Sequenced first so accurate header dimensions and offsets are available before initial restoration.\n afterRenderEffect((onCleanup) => {\n const selector = this.options().headerSelector;\n const header = selector ? this.document.querySelector<HTMLElement>(selector) : null;\n const measure = () => {\n const height = header?.getBoundingClientRect().height ?? 0;\n if (height !== this.headerHeight()) {\n this.measuredHeaderHeight.set(height);\n if (this.options().preserveOnResize) this.preserve();\n }\n };\n untracked(measure);\n if (header) {\n const observer = new ResizeObserver(measure);\n observer.observe(header);\n onCleanup(() => observer.disconnect());\n }\n });\n\n // Phase 2: Asynchronous scrollSource readiness, initial restoration, and data-change preservation.\n // Untracked execution guarantees execution triggers strictly on scrollSource readiness transitions.\n afterRenderEffect(() => {\n const source = this.scrollSource();\n const state = readScrollSource(source);\n if (!state.ready) return;\n untracked(() => {\n if (!this.initialized) {\n this.initialized = true;\n if (!this.userInterrupted) {\n this.execute(this.initialAnchor, { behavior: this.options().behavior.restoration });\n } else {\n this.liveAnchor.set(this.calculateNearestAnchor() ?? null);\n }\n } else if (source !== NO_SCROLL_SOURCE && this.options().restoreOnDataChange) {\n this.preserve('top');\n }\n });\n });\n\n // Phase 3: Route fragment synchronization to liveAnchor.\n // When the route fragment changes externally (e.g., router navigation), synchronize liveAnchor.\n effect(() => {\n const frag = this.fragment();\n untracked(() => {\n this.liveAnchor.set(frag);\n });\n });\n\n // Phase 4: Scroll revision debounced publication to URL fragment.\n // Re-evaluates nearest anchor and commits it to the URL router after debounce delay.\n effect(() => {\n if (!this.scrollRevision()) return;\n const anchor = this.calculateNearestAnchor();\n if (anchor) this.fragment.set(anchor);\n });\n }\n\n /**\n * Explicitly scrolls the viewport to the target anchor identifier.\n *\n * @param anchor - Target anchor ID (with or without leading `#`).\n * @param options - Per-call scroll overrides (behavior, top offset, ignoreWhenInView).\n * @returns `true` if the target anchor was found and scrolling initiated; `false` otherwise.\n *\n * @remarks\n * Successful execution immediately synchronizes both `liveAnchor` and the router `fragment`\n * with the target anchor, overriding any in-flight debounce delays.\n */\n scrollTo(anchor: string, options: MagicScrollToOptions = {}): boolean {\n const executed = this.execute(anchor, {\n behavior: this.options().behavior.interaction,\n ignoreWhenInView: this.options().ignoreWhenInView,\n ...options,\n });\n if (executed) {\n const clean = anchor.replace(/^#/, '');\n this.liveAnchor.set(clean);\n this.fragment.set(clean);\n }\n return executed;\n }\n\n /**\n * Queries and returns all eligible scroll anchor elements belonging strictly to this directive instance.\n *\n * @remarks\n * Anchors must possess a non-empty `id` and either match the configured `anchorPrefix` or contain\n * the `data-scroll-anchor` attribute. The `closest('[magicScroll]') === this.host` check prevents\n * nested or parent `magicScroll` directive instances from capturing child anchors across boundaries.\n */\n private anchors(): HTMLElement[] {\n const prefix = this.options().anchorPrefix;\n return Array.from(this.host.querySelectorAll<HTMLElement>('[id]')).filter(\n (el) =>\n !!el.id &&\n (el.hasAttribute('data-scroll-anchor') || el.id.startsWith(prefix)) &&\n el.closest('[magicScroll]') === this.host,\n );\n }\n\n /**\n * Resolves the active scroll container element governing viewport offsets.\n *\n * @returns The scrollable container `HTMLElement`, or `undefined` when scrolling against the document root / window.\n */\n private scrollable(): HTMLElement | undefined {\n const overflow = getComputedStyle(this.host).overflowY;\n const container =\n overflow === 'auto' || overflow === 'scroll'\n ? this.host\n : injectScrollableParentElement(this.host);\n // Root scrolling emits events on document, even when overflow is set on body/html.\n return container === this.document.documentElement || container === this.document.body\n ? undefined\n : container;\n }\n\n /**\n * Computes the nearest visible anchor according to current viewport geometry, header offsets,\n * bottom offsets, and reading direction thresholds.\n */\n private calculateNearestAnchor(): string | undefined {\n return this.nearest.getNearestAnchor({\n hostElement: this.host,\n anchors: this.anchors(),\n scrollable: this.scrollable(),\n headerOffset: this.offset(),\n bottomOffset: this.options().bottomOffset,\n activationThreshold: this.options().activationThreshold,\n });\n }\n\n /**\n * Dispatches scrolling to the underlying {@link ScrollService} after validating target presence.\n */\n private execute(anchor: string | null | undefined, options: MagicScrollToOptions): boolean {\n if (!anchor || !this.anchors().some((el) => el.id === anchor.replace(/^#/, ''))) return false;\n return this.service.scroll(anchor, {\n scrollable: this.scrollable(),\n topOffset: this.offset(),\n ...options,\n });\n }\n\n /**\n * Realigns the viewport instantly to preserve position during asynchronous data updates\n * or container / header dimension changes.\n *\n * @remarks\n * Targets `liveAnchor` (the real-time visible section) rather than `fragment` (the debounced URL fragment)\n * to ensure rapid data or layout shifts during continuous scrolling maintain the user's active view\n * rather than jumping back to a stale URL anchor.\n */\n private preserve(ignoreWhenInView: ScrollOptions['ignoreWhenInView'] = 'none'): void {\n if (this.initialized) {\n this.execute(this.liveAnchor(), { behavior: 'instant', ignoreWhenInView });\n }\n }\n\n /**\n * Updates target container references and re-binds passive event listeners whenever\n * the scroll container shifts dynamically.\n */\n private refreshTarget(): void {\n const target = this.scrollable() ?? this.document;\n if (target !== this.target) {\n this.detachListeners();\n this.target = target;\n this.attachListeners(target);\n }\n }\n\n /**\n * Attaches passive scroll, gesture, and keyboard listeners to track user intent and scroll motion.\n */\n private attachListeners(target: EventTarget): void {\n target.addEventListener('scroll', this.onScroll);\n target.addEventListener('wheel', this.onUserIntent, { passive: true });\n target.addEventListener('touchstart', this.onUserIntent, { passive: true });\n target.addEventListener('touchmove', this.onUserIntent, { passive: true });\n target.addEventListener('keydown', this.onKeyDown);\n this.document.addEventListener('keydown', this.onKeyDown);\n }\n\n /**\n * Detaches all registered event listeners to ensure clean teardown without memory leaks.\n */\n private detachListeners(): void {\n if (!this.target) return;\n this.target.removeEventListener('scroll', this.onScroll);\n this.target.removeEventListener('wheel', this.onUserIntent);\n this.target.removeEventListener('touchstart', this.onUserIntent);\n this.target.removeEventListener('touchmove', this.onUserIntent);\n this.target.removeEventListener('keydown', this.onKeyDown);\n this.document.removeEventListener('keydown', this.onKeyDown);\n }\n\n /**\n * Intercepts manual user gestures (`wheel`, `touchstart`, `touchmove`) to flag user interaction\n * and cancel delayed initial restorations prior to data readiness.\n */\n private readonly onUserIntent = () => {\n this.userInterrupted = true;\n };\n\n /**\n * Intercepts navigation keyboard events (`ArrowUp`, `ArrowDown`, `PageUp`, `PageDown`, `Home`, `End`, `Space`).\n * Cancels pending initial restoration when navigation occurs within the relevant scroll context\n * while safely ignoring interactions on editable input elements.\n */\n private readonly onKeyDown = (event: Event) => {\n if (!(event instanceof KeyboardEvent)) return;\n if (isEditableTarget(event.target)) return;\n if (!SCROLL_KEYS.has(event.key)) return;\n const targetEl = event.target as Element | null;\n const scrollable = this.scrollable();\n const isInsideContext =\n !targetEl ||\n targetEl === this.document.body ||\n targetEl === this.document.documentElement ||\n (scrollable ? scrollable === targetEl || scrollable.contains(targetEl) : true);\n if (isInsideContext) {\n this.userInterrupted = true;\n }\n };\n\n /**\n * Handles scroll events by immediately updating `liveAnchor` for position preservation,\n * while debouncing `scrollRevision` increments to update the browser URL fragment without thrashing history.\n */\n private readonly onScroll = () => {\n if (!this.initialized) return;\n const anchor = this.calculateNearestAnchor();\n if (anchor) this.liveAnchor.set(anchor);\n clearTimeout(this.timer);\n this.timer = setTimeout(\n () => this.scrollRevision.update((revision) => revision + 1),\n this.options().debounceTime,\n );\n };\n\n /**\n * Handles window resize events by re-evaluating targets and optionally realigning the active anchor.\n */\n private readonly onResize = () => {\n this.refreshTarget();\n if (this.options().preserveOnResize) this.preserve();\n };\n}\n","import { Directive, effect, ElementRef, inject, input } from '@angular/core';\n\n/**\n * Optional explicit anchor. Its ID participates even outside the configured prefix.\n * Use `scrollAnchor` alongside an existing id, or `[scrollAnchor]=\"item.id\"` to set it.\n */\n@Directive({\n selector: '[scrollAnchor]',\n host: { '[attr.data-scroll-anchor]': '\"\"' },\n})\nexport class ScrollAnchorDirective {\n readonly scrollAnchor = input('');\n private readonly host = inject<ElementRef<HTMLElement>>(ElementRef);\n constructor() {\n effect(() => {\n const id = this.scrollAnchor();\n if (id) this.host.nativeElement.id = id;\n });\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,SAAgB,sBAAmB;CACjC,MAAM,QAAQ,OAAO,cAAc;CACnC,MAAM,SAAS,OAAO,MAAM;CAC5B,MAAM,WAAW,SAAS,MAAM,QAAQ;CAExC,MAAM,iBAAiB,mBAAmB,SAAQ,GAAG,GAAA,YAAA,CAAA,EAAA,WAAA,iBAAA,CAAA,+BAAA,CAAA,CAAA;CAErD,aAAY;EACV,MAAM,cAAc,eAAc;EAClC,IAAI,MAAM,SAAS,aAAa,aAAa;GAC3C,MAAM,OAAO,OAAO,cAAc,CAAA,GAAI;IACpC,YAAY;IACZ,UAAU,eAAe;IACzB,qBAAqB;GACtB,CAAA;GAED,OAAO,cAAc,MAAM,EAAE,YAAY,KAAI,CAAE,CAAC,CAAC,OAAO,UAAgB;IACtE,QAAQ,IAAI,qBAAqB,eAAe,KAAK;GACvD,CAAC;EACH;CACF,CAAC;CAED,OAAO;AACT;AC9BA,SAAgB,8BACd,aAAgC;CAEhC,SAAS,qBAAqB,IAAe;EAC3C,IAAI,UAAU,GAAG,iBAAiB;EAClC,OAAO,SAAS;GACd,MAAM,YAAY,iBAAiB,OAAO,CAAC,CAAC;GAC5C,IACE,cAAc,UACd,cAAc,UAEd,OAAO;GAET,UAAU,QAAQ,iBAAiB;EACrC;CAEF;CAEA,OAAO,qBACL,eAAgB,OAAO,UAAuB,CAAC,CAAC,aAA6B;AAEjF;AC5BA,SAAgB,qBAAqB,gBAAwB,UAAkB;CAC7E,MAAM,cAAc,SAAS,cAA2B,cAAc,CAAC,EAAE,sBAAqB;CAC9F,IAAI,CAAC,aAAa;EAChB,QAAQ,KAAK,6CAA6C,cAAc;EACxE,OAAO;CACT;CAEA,OAAO,KAAK,IAAI,YAAY,MAAM;AACpC;ACkCA,IAAa,wBAAb,MAAa,sBAAqB;CACf,WAAW,OAAO,QAAQ;CAuBpC,iBAAiB,SAA8B;EACpD,MAAM,OAAO,SAAS,eAAe,KAAK;EAC1C,MAAM,WAAW,SAAS,YAAY;EACtC,MAAM,UACH,SAAS,gBAAgB,MACzB,SAAS,iBAAiB,qBAAqB,QAAQ,gBAAgB,KAAK,QAAQ,IAAI;EAG3F,MAAM,UAAU,SAAS,WAAW,MAAM,KAAK,KAAK,iBAA8B,QAAQ,CAAC;EAC3F,IAAI,QAAQ,WAAW,GACrB;EAGF,MAAM,aACJ,SAAS,eACR,SAAS,cAAc,8BAA8B,QAAQ,WAAW,IAAI;EAC/E,MAAM,aACJ,CAAC,cACD,eAAe,KAAK,SAAS,mBAC7B,eAAe,KAAK,SAAS;EAC/B,MAAM,eAAe,aAAa,IAAI,WAAW,sBAAqB,CAAE,CAAC,OAAO;EAChF,MAAM,iBAAiB,aAClB,KAAK,SAAS,aAAa,eAAe,KAAK,SAAS,gBAAgB,eACzE,WAAW,sBAAqB,CAAE,CAAC;EACvC,MAAM,iBAAiB,KAAK,IAC1B,aACA,iBAAiB,KAAK,IAAI,GAAG,SAAS,gBAAgB,CAAC,CAAC;EAI1D,MAAM,mBAAmB,QAAQ,QAAQ,OAAM;GAC7C,MAAM,OAAO,GAAG,sBAAqB;GACrC,OAAO,KAAK,OAAO,cAAc,KAAK,KAAK,UAAU,iBAAiB;EACxE,CAAC;EAED,IAAI,iBAAiB,SAAS,GAK5B,OAHyB,iBAAiB,QAAQ,MAAM,OACtD,GAAG,sBAAqB,CAAE,CAAC,MAAM,KAAK,sBAAqB,CAAE,CAAC,MAAM,KAAK,IAEpE,CAAA,CAAiB;EAI1B,MAAM,YAAY,KAAK,IAAI,GAAG,KAAK,IAAI,GAAG,SAAS,uBAAuB,CAAC,CAAC;EAC5E,MAAM,cAAc,eAAe,iBAAiB,eAAe;EACnE,MAAM,gBAAgB,QAAQ,QAAQ,OAAO,GAAG,sBAAqB,CAAE,CAAC,OAAO,cAAc,CAAC;EAE9F,IAAI,cAAc,SAAS,GAKzB,OAHe,cAAc,QAAQ,MAAM,OACzC,GAAG,sBAAqB,CAAE,CAAC,MAAM,KAAK,sBAAqB,CAAE,CAAC,MAAM,KAAK,IAEpE,CAAA,CAAO;EAOhB,OAHc,QAAQ,QAAQ,MAAM,OAClC,GAAG,sBAAqB,CAAE,CAAC,MAAM,KAAK,sBAAqB,CAAE,CAAC,MAAM,KAAK,IAEpE,CAAA,CAAM;CACf;CArFW,OAAA,OAAA,GAAA,mBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,UAAA;EAAA,MAAA;EAAqB,MAAA,CAAA;EAAA,QAAA,GAAA,gBAAA;CAAA,CAAA;CAArB,OAAA,QAAA,GAAA,sBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,UAAA;EAAA,MAAA;CAAqB,CAAA;;AAArB,GAAA,yBAAA;CAAA,YAAA;CAAA,SAAA;CAAA,UAAA;CAAA,MAAA;CAAqB,YAAA,CAAA,EADjC,MAAA,WAAA,CAAA;;ACfD,IAAa,gBAAb,MAAa,cAAa;CACP,WAAW,OAAiB,QAAQ;CACpC,aAAa;CAsB9B,OAAO,QAAgB,SAAuB;EAC5C,MAAM,YAAY,OAAO,WAAW,GAAG,IAAI,OAAO,MAAM,CAAC,IAAI;EAC7D,MAAM,KAAK,KAAK,SAAS,eAAe,SAAS;EAEjD,IAAI,CAAC,IACH,OAAO;EAGT,MAAM,aACJ,SAAS,cACR,KAAK,SAAS,oBACf,KAAK,SAAS;EAChB,MAAM,WAAW,SAAS,YAAY;EACtC,MAAM,mBAAmB,SAAS,oBAAoB;EACtD,MAAM,YAAY,SAAS,aAAa,KAAK;EAE7C,MAAM,OAAO,GAAG,sBAAqB;EACrC,MAAM,aACJ,eAAe,KAAK,SAAS,mBAAmB,eAAe,KAAK,SAAS;EAC/E,MAAM,eAAe,aAAa,IAAI,WAAW,sBAAqB,CAAE,CAAC;EACzE,MAAM,iBAAiB,aACnB,KAAK,SAAS,gBAAgB,eAC9B,WAAW;EACf,MAAM,cACJ,KAAK,OAAO,eAAe,YAAY,KAAK,KAAK,MAAM,eAAe;EACxE,MAAM,iBACJ,KAAK,UAAU,eAAe,kBAAkB,KAAK,SAAS;EAEhE,IACG,oBAAoB,SAAS,eAC7B,oBAAoB,UAAU,eAAe,kBAC7C,oBAAoB,aAAa,eAAe,iBAEjD,OAAO;EAIT,WAAW,SAAS;GAClB,KAAK,WAAW,YAAY,KAAK,MAAM,eAAe;GACtD;EACD,CAAA;EAED,OAAO;CACT;CAnEW,OAAA,OAAA,GAAA,mBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,UAAA;EAAA,MAAA;EAAa,MAAA,CAAA;EAAA,QAAA,GAAA,gBAAA;CAAA,CAAA;CAAb,OAAA,QAAA,GAAA,sBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,UAAA;EAAA,MAAA;EAAa,YAFZ;CAAM,CAAA;;AAEP,GAAA,yBAAA;CAAA,YAAA;CAAA,SAAA;CAAA,UAAA;CAAA,MAAA;CAAa,YAAA,CAAA;EAHzB,MAAA;EAAW,MAAA,CAAA,EACV,YAAY,OACb,CAAA;;;ACED,MAAM,WAAuC;CAC3C,cAAc;CACd,gBAAgB;CAChB,cAAc;CACd,cAAc;CACd,qBAAqB;CACrB,UAAU;EAAE,aAAa;EAAW,aAAa;CAAQ;CACzD,cAAc;CACd,kBAAkB;CAClB,qBAAqB;CACrB,kBAAkB;AACnB;AAED,SAAgB,0BACd,QACA,SAA2B;CAE3B,OAAO;EACL,cAAc,QAAQ,gBAAgB,OAAO;EAC7C,gBAAgB,QAAQ,kBAAkB,OAAO;EACjD,cAAc,QAAQ,gBAAgB,OAAO;EAC7C,cAAc,QAAQ,gBAAgB,OAAO;EAC7C,qBAAqB,QAAQ,uBAAuB,OAAO;EAC3D,UAAU;GACR,aAAa,QAAQ,UAAU,eAAe,OAAO,SAAS;GAC9D,aAAa,QAAQ,UAAU,eAAe,OAAO,SAAS;EAC/D;EACD,cAAc,QAAQ,gBAAgB,OAAO;EAC7C,kBAAkB,QAAQ,oBAAoB,OAAO;EACrD,qBAAqB,QAAQ,uBAAuB,OAAO;EAC3D,kBAAkB,QAAQ,oBAAoB,OAAO;CACtD;AACH;AAEA,MAAa,uBAAuB,IAAI,eACtC,yBACA;CAAE,YAAY;CAAQ,eAAe;AAAQ,CAAE;AAUjD,SAAgB,mBAAmB,UAA8B,CAAA,GAAE;CACjE,OAAO;EACL,SAAS;EACT,kBACE,0BACE,OAAO,sBAAsB;GAAE,UAAU;GAAM,UAAU;EAAI,CAAE,KAAK,UACpE,OAAO;CAEZ;AACH;ACrEA,MAAa,mBAAmB,OAAO,+BAA+B;AAGtE,SAAgB,iBAAiB,QAA8C;CAI7E,IAAI,WAAW,kBAAkB,OAAO;EAAE,OAAO;EAAM,MAAM;CAAM;CACnE,IAAI,OAAgB;CACpB,OAAO,SAAS,IAAI,GAAG,OAAO,KAAI;CAClC,IAAI,SAAS,QAAQ,OAAO,SAAS,UAAU;EAG7C,MAAM,YAAY;EAClB,IAAI,OAAO,UAAU,cAAc,YAAY;GAC7C,IAAI,UAAU,UAAS,GAAI,OAAO;IAAE,OAAO;IAAO,MAAM;GAAS;GACjE,IAAI,WAAW,QAAQ,OAAO,KAAK,UAAU,YAAY;IACvD,MAAM,WAAW;IAEjB,OAAO,SAAS,YAAY,CAAC,SAAS,SAAQ,IAAK,SAAY,SAAS,MAAK;GAC/E,OAAO,IAAI,OAAO,UAAU,SAAS,YACnC,OAAO,UAAU,KAAI;EAEzB;CACF;CACA,OAAO;EAAE,OAAO,SAAS,UAAa,SAAS;EAAM;CAAI;AAC3D;ACbA,MAAM,8BAAc,IAAI,IAAI;CAC1B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD,CAAA;AAOD,SAAS,iBAAiB,QAA0B;CAClD,IAAI,CAAC,UAAU,EAAE,kBAAkB,UAAU,OAAO;CACpD,MAAM,UAAU,OAAO,QAAQ,YAAW;CAC1C,IAAI,YAAY,WAAW,YAAY,cAAc,YAAY,UAAU,OAAO;CAElF,MAAM,gBADe,OAAO,QAAQ,mBACd,CAAA,EAAc,aAAa,iBAAiB,CAAC,EAAE,YAAW;CAChF,OAAO,QACJ,OAAuB,qBACxB,OAAO,QAAQ,yBAAyB,KACxC,kBAAkB,MAClB,kBAAkB,UAClB,kBAAkB,gBAAgB;AAEtC;AAyCA,IAAa,uBAAb,MAAa,qBAAoB;CAOtB,eAAe,MACtB,kBAAgB;EAAA,GAAA,YAAA,EAAA,WAAA,eAAA,+BAAA,CAAA;EACd,YAAY,UAAU;CAAK,CAAA;CAItB,gBAAgB,MAA0B,CAAA,GAAG,GAAA,YAAA,CAAA,EAAA,WAAA,gBAAA,CAAA,+BAAA,CAAA,CAAA;CAErC,WAAW,OAAO,oBAAoB;CACtC,UAAU,eACzB,0BAA0B,KAAK,UAAU,KAAK,cAAa,CAAE,GAC9D,GAAA,YAAA,CAAA,EAAA,WAAA,UAAA,CAAA,+BAAA,CAAA,CAAA;CACgB,WAAW,OAAO,QAAQ;CAC1B,OAAO,OAAgC,UAAU,CAAC,CAAC;CACnD,UAAU,OAAO,aAAa;CAC9B,UAAU,OAAO,qBAAqB;CAGtC,WAAW,oBAAmB;CAG9B,gBAAgB,OAAO,cAAc,CAAC,CAAC,SAAS;CAGhD,uBAAuB,OAAO,GAAE,GAAA,YAAA,CAAA,EAAA,WAAA,uBAAA,CAAA,+BAAA,CAAA,CAAA;CAOhC,aAAa,OAAkC,MAAK,GAAA,YAAA,CAAA,EAAA,WAAA,aAAA,CAAA,+BAAA,CAAA,CAAA;CAG5D,eAAe,KAAK,SAAS,WAAU;CAGvC,eAAe,KAAK,qBAAqB,WAAU;CAGnD,SAAS,eAAe,KAAK,aAAY,IAAK,KAAK,QAAO,CAAE,CAAC,cAAa,GAAA,YAAA,CAAA,EAAA,WAAA,SAAA,CAAA,+BAAA,CAAA,CAAA;CAGlE,iBAAiB,OAAO,GAAE,GAAA,YAAA,CAAA,EAAA,WAAA,iBAAA,CAAA,+BAAA,CAAA,CAAA;CAGnC,cAAc;CAMd,kBAAkB;CAElB;CACA;CAER,cAAA;EACE,MAAM,aAAa,OAAO,UAAU;EACpC,sBAAqB;GACnB,KAAK,cAAa;GAClB,KAAK,SAAS,aAAa,iBAAiB,UAAU,KAAK,QAAQ;EACrE,CAAC;EACD,WAAW,gBAAe;GACxB,KAAK,gBAAe;GACpB,KAAK,SAAS,aAAa,oBAAoB,UAAU,KAAK,QAAQ;GACtE,aAAa,KAAK,KAAK;EACzB,CAAC;EAID,mBAAmB,cAAa;GAC9B,MAAM,WAAW,KAAK,QAAO,CAAE,CAAC;GAChC,MAAM,SAAS,WAAW,KAAK,SAAS,cAA2B,QAAQ,IAAI;GAC/E,MAAM,gBAAe;IACnB,MAAM,SAAS,QAAQ,sBAAqB,CAAE,CAAC,UAAU;IACzD,IAAI,WAAW,KAAK,aAAY,GAAI;KAClC,KAAK,qBAAqB,IAAI,MAAM;KACpC,IAAI,KAAK,QAAO,CAAE,CAAC,kBAAkB,KAAK,SAAQ;IACpD;GACF;GACA,UAAU,OAAO;GACjB,IAAI,QAAQ;IACV,MAAM,WAAW,IAAI,eAAe,OAAO;IAC3C,SAAS,QAAQ,MAAM;IACvB,gBAAgB,SAAS,WAAU,CAAE;GACvC;EACF,CAAC;EAID,wBAAuB;GACrB,MAAM,SAAS,KAAK,aAAY;GAEhC,IAAI,CADU,iBAAiB,MAC1B,CAAA,CAAM,OAAO;GAClB,gBAAe;IACb,IAAI,CAAC,KAAK,aAAa;KACrB,KAAK,cAAc;KACnB,IAAI,CAAC,KAAK,iBACR,KAAK,QAAQ,KAAK,eAAe,EAAE,UAAU,KAAK,QAAO,CAAE,CAAC,SAAS,YAAW,CAAE;UAElF,KAAK,WAAW,IAAI,KAAK,uBAAsB,KAAM,IAAI;IAE7D,OAAO,IAAI,WAAW,oBAAoB,KAAK,QAAO,CAAE,CAAC,qBACvD,KAAK,SAAS,KAAK;GAEvB,CAAC;EACH,CAAC;EAID,aAAY;GACV,MAAM,OAAO,KAAK,SAAQ;GAC1B,gBAAe;IACb,KAAK,WAAW,IAAI,IAAI;GAC1B,CAAC;EACH,CAAC;EAID,aAAY;GACV,IAAI,CAAC,KAAK,eAAc,GAAI;GAC5B,MAAM,SAAS,KAAK,uBAAsB;GAC1C,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM;EACtC,CAAC;CACH;CAaA,SAAS,QAAgB,UAAgC,CAAA,GAAE;EACzD,MAAM,WAAW,KAAK,QAAQ,QAAQ;GACpC,UAAU,KAAK,QAAO,CAAE,CAAC,SAAS;GAClC,kBAAkB,KAAK,QAAO,CAAE,CAAC;GACjC,GAAG;EACJ,CAAA;EACD,IAAI,UAAU;GACZ,MAAM,QAAQ,OAAO,QAAQ,MAAM,EAAE;GACrC,KAAK,WAAW,IAAI,KAAK;GACzB,KAAK,SAAS,IAAI,KAAK;EACzB;EACA,OAAO;CACT;CAUQ,UAAO;EACb,MAAM,SAAS,KAAK,QAAO,CAAE,CAAC;EAC9B,OAAO,MAAM,KAAK,KAAK,KAAK,iBAA8B,MAAM,CAAC,CAAC,CAAC,QAChE,OACC,CAAC,CAAC,GAAG,OACJ,GAAG,aAAa,oBAAoB,KAAK,GAAG,GAAG,WAAW,MAAM,MACjE,GAAG,QAAQ,eAAe,MAAM,KAAK,IAAI;CAE/C;CAOQ,aAAU;EAChB,MAAM,WAAW,iBAAiB,KAAK,IAAI,CAAC,CAAC;EAC7C,MAAM,YACJ,aAAa,UAAU,aAAa,WAChC,KAAK,OACL,8BAA8B,KAAK,IAAI;EAE7C,OAAO,cAAc,KAAK,SAAS,mBAAmB,cAAc,KAAK,SAAS,OAC9E,SACA;CACN;CAMQ,yBAAsB;EAC5B,OAAO,KAAK,QAAQ,iBAAiB;GACnC,aAAa,KAAK;GAClB,SAAS,KAAK,QAAO;GACrB,YAAY,KAAK,WAAU;GAC3B,cAAc,KAAK,OAAM;GACzB,cAAc,KAAK,QAAO,CAAE,CAAC;GAC7B,qBAAqB,KAAK,QAAO,CAAE,CAAC;EACrC,CAAA;CACH;CAKQ,QAAQ,QAAmC,SAA6B;EAC9E,IAAI,CAAC,UAAU,CAAC,KAAK,QAAO,CAAE,CAAC,MAAM,OAAO,GAAG,OAAO,OAAO,QAAQ,MAAM,EAAE,CAAC,GAAG,OAAO;EACxF,OAAO,KAAK,QAAQ,OAAO,QAAQ;GACjC,YAAY,KAAK,WAAU;GAC3B,WAAW,KAAK,OAAM;GACtB,GAAG;EACJ,CAAA;CACH;CAWQ,SAAS,mBAAsD,QAAM;EAC3E,IAAI,KAAK,aACP,KAAK,QAAQ,KAAK,WAAU,GAAI;GAAE,UAAU;GAAW;EAAgB,CAAE;CAE7E;CAMQ,gBAAa;EACnB,MAAM,SAAS,KAAK,WAAU,KAAM,KAAK;EACzC,IAAI,WAAW,KAAK,QAAQ;GAC1B,KAAK,gBAAe;GACpB,KAAK,SAAS;GACd,KAAK,gBAAgB,MAAM;EAC7B;CACF;CAKQ,gBAAgB,QAAmB;EACzC,OAAO,iBAAiB,UAAU,KAAK,QAAQ;EAC/C,OAAO,iBAAiB,SAAS,KAAK,cAAc,EAAE,SAAS,KAAI,CAAE;EACrE,OAAO,iBAAiB,cAAc,KAAK,cAAc,EAAE,SAAS,KAAI,CAAE;EAC1E,OAAO,iBAAiB,aAAa,KAAK,cAAc,EAAE,SAAS,KAAI,CAAE;EACzE,OAAO,iBAAiB,WAAW,KAAK,SAAS;EACjD,KAAK,SAAS,iBAAiB,WAAW,KAAK,SAAS;CAC1D;CAKQ,kBAAe;EACrB,IAAI,CAAC,KAAK,QAAQ;EAClB,KAAK,OAAO,oBAAoB,UAAU,KAAK,QAAQ;EACvD,KAAK,OAAO,oBAAoB,SAAS,KAAK,YAAY;EAC1D,KAAK,OAAO,oBAAoB,cAAc,KAAK,YAAY;EAC/D,KAAK,OAAO,oBAAoB,aAAa,KAAK,YAAY;EAC9D,KAAK,OAAO,oBAAoB,WAAW,KAAK,SAAS;EACzD,KAAK,SAAS,oBAAoB,WAAW,KAAK,SAAS;CAC7D;CAMiB,qBAAoB;EACnC,KAAK,kBAAkB;CACzB;CAOiB,aAAa,UAAgB;EAC5C,IAAI,EAAE,iBAAiB,gBAAgB;EACvC,IAAI,iBAAiB,MAAM,MAAM,GAAG;EACpC,IAAI,CAAC,YAAY,IAAI,MAAM,GAAG,GAAG;EACjC,MAAM,WAAW,MAAM;EACvB,MAAM,aAAa,KAAK,WAAU;EAMlC,IAJE,CAAC,YACD,aAAa,KAAK,SAAS,QAC3B,aAAa,KAAK,SAAS,oBAC1B,aAAa,eAAe,YAAY,WAAW,SAAS,QAAQ,IAAI,OAEzE,KAAK,kBAAkB;CAE3B;CAMiB,iBAAgB;EAC/B,IAAI,CAAC,KAAK,aAAa;EACvB,MAAM,SAAS,KAAK,uBAAsB;EAC1C,IAAI,QAAQ,KAAK,WAAW,IAAI,MAAM;EACtC,aAAa,KAAK,KAAK;EACvB,KAAK,QAAQ,iBACL,KAAK,eAAe,QAAQ,aAAa,WAAW,CAAC,GAC3D,KAAK,QAAO,CAAE,CAAC,YAAY;CAE/B;CAKiB,iBAAgB;EAC/B,KAAK,cAAa;EAClB,IAAI,KAAK,QAAO,CAAE,CAAC,kBAAkB,KAAK,SAAQ;CACpD;CApUW,OAAA,OAAA,GAAA,mBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,UAAA;EAAA,MAAA;EAAoB,MAAA,CAAA;EAAA,QAAA,GAAA,gBAAA;CAAA,CAAA;CAApB,OAAA,OAAA,GAAA,qBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,MAAA;EAAoB,cAAA;EAAA,UAAA;EAAA,QAAA;GAAA,cAAA;IAAA,mBAAA;IAAA,YAAA;IAAA,UAAA;IAAA,YAAA;IAAA,mBAAA;GAAA;GAAA,eAAA;IAAA,mBAAA;IAAA,YAAA;IAAA,UAAA;IAAA,YAAA;IAAA,mBAAA;GAAA;EAAA;EAAA,MAAA,EAAA,YAAA,EAAA,oBAAA,OAAA,EAAA;EAAA,WAHpB,CAAC,qBAAqB;EAAC,UAAA,CAAA,aAAA;EAAA,UAAA;CAAA,CAAA;;AAGvB,GAAA,yBAAA;CAAA,YAAA;CAAA,SAAA;CAAA,UAAA;CAAA,MAAA;CAAoB,YAAA,CAAA;EANhC,MAAA;EAAU,MAAA,CAAA;GACT,UAAU;GACV,UAAU;GACV,WAAW,CAAC,qBAAqB;GACjC,MAAM,EAAE,sBAAsB,OAAI;EACnC,CAAA;;;;;;;;;;;;;;;;;;;;;;ACpGD,IAAa,wBAAb,MAAa,sBAAqB;CACvB,eAAe,MAAM,IAAG,GAAA,YAAA,CAAA,EAAA,WAAA,eAAA,CAAA,+BAAA,CAAA,CAAA;CAChB,OAAO,OAAgC,UAAU;CAClE,cAAA;EACE,aAAY;GACV,MAAM,KAAK,KAAK,aAAY;GAC5B,IAAI,IAAI,KAAK,KAAK,cAAc,KAAK;EACvC,CAAC;CACH;CARW,OAAA,OAAA,GAAA,mBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,UAAA;EAAA,MAAA;EAAqB,MAAA,CAAA;EAAA,QAAA,GAAA,gBAAA;CAAA,CAAA;CAArB,OAAA,OAAA,GAAA,qBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,MAAA;EAAqB,cAAA;EAAA,UAAA;EAAA,QAAA,EAAA,cAAA;GAAA,mBAAA;GAAA,YAAA;GAAA,UAAA;GAAA,YAAA;GAAA,mBAAA;EAAA,EAAA;EAAA,MAAA,EAAA,YAAA,EAAA,2BAAA,OAAA,EAAA;EAAA,UAAA;CAAA,CAAA;;AAArB,GAAA,yBAAA;CAAA,YAAA;CAAA,SAAA;CAAA,UAAA;CAAA,MAAA;CAAqB,YAAA,CAAA;EAJjC,MAAA;EAAU,MAAA,CAAA;GACT,UAAU;GACV,MAAM,EAAE,6BAA6B,OAAI;EAC1C,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,46 @@
1
1
  {
2
2
  "name": "@devzwo/ngx-magic-scroll",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "version": "0.0.1-rc.2",
4
+ "peerDependencies": {
5
+ "@angular/common": "^22.2.0",
6
+ "@angular/core": "^22.2.0",
7
+ "@angular/router": "^22.2.0",
8
+ "rxjs": "^7.8.0"
9
+ },
10
+ "dependencies": {
11
+ "tslib": "^2.3.0"
12
+ },
13
+ "sideEffects": false,
14
+ "description": "Angular signal utilities for anchor scrolling and navigation state.",
15
+ "license": "MIT",
16
+ "repository": {
17
+ "type": "git",
18
+ "url": "git+https://github.com/devZWO/ngx-magic-scroll.git",
19
+ "directory": "projects/ngx-magic-scroll"
20
+ },
21
+ "homepage": "https://devzwo.github.io/ngx-magic-scroll/",
22
+ "bugs": {
23
+ "url": "https://github.com/devZWO/ngx-magic-scroll/issues"
24
+ },
25
+ "keywords": [
26
+ "angular",
27
+ "signals",
28
+ "scroll",
29
+ "navigation"
30
+ ],
31
+ "publishConfig": {
32
+ "access": "public"
33
+ },
34
+ "module": "fesm2022/devzwo-ngx-magic-scroll.mjs",
35
+ "typings": "types/devzwo-ngx-magic-scroll.d.ts",
36
+ "exports": {
37
+ "./package.json": {
38
+ "default": "./package.json"
39
+ },
40
+ ".": {
41
+ "types": "./types/devzwo-ngx-magic-scroll.d.ts",
42
+ "default": "./fesm2022/devzwo-ngx-magic-scroll.mjs"
43
+ }
44
+ },
45
+ "type": "module"
6
46
  }
@@ -0,0 +1,333 @@
1
+ import * as i0 from "@angular/core";
2
+ import { InjectionToken, Provider, Signal } from "@angular/core";
3
+ /**
4
+ * Options for a scroll operation performed by ScrollService.
5
+ */
6
+ interface ScrollOptions {
7
+ /**
8
+ * Scrollable container. Defaults to the document's scrolling element.
9
+ */
10
+ scrollable?: HTMLElement;
11
+ /**
12
+ * Scroll behavior: 'instant' for an immediate jump, 'smooth' for animation,
13
+ * or 'auto' to follow the browser's CSS scroll behavior. Defaults to 'instant'.
14
+ */
15
+ behavior?: ScrollBehavior;
16
+ /**
17
+ * Visibility condition under which scrolling is skipped:
18
+ * - 'none': Always scroll (default).
19
+ * - 'top': Skip when the element's top edge is visible.
20
+ * - 'full': Skip when the entire element is visible.
21
+ * - 'always': Skip when either the top or bottom edge is visible.
22
+ */
23
+ ignoreWhenInView?: 'none' | 'top' | 'full' | 'always';
24
+ /**
25
+ * Additional top offset for the target, in pixels, for example for a header or padding.
26
+ * Defaults to 20 pixels.
27
+ */
28
+ topOffset?: number;
29
+ }
30
+ /**
31
+ * Central service for scrolling to DOM elements and anchors.
32
+ *
33
+ * Supports explicit scroll containers or document scrolling, configurable header offsets,
34
+ * visibility checks to avoid unnecessary movement, and smooth or instant scrolling.
35
+ */
36
+ declare class ScrollService {
37
+ private readonly document;
38
+ private readonly TOP_OFFSET;
39
+ /**
40
+ * Scrolls to the element identified by its ID.
41
+ *
42
+ * @param anchor - Target HTML element ID, with or without a leading #.
43
+ * @param options - Scroll container, behavior, offset and visibility settings.
44
+ * @returns True when the target exists and scrolling is initiated; otherwise false.
45
+ * @example
46
+ * ```ts
47
+ * // Simple scrolling
48
+ * scrollService.scroll('section-details');
49
+ *
50
+ * // With options
51
+ * scrollService.scroll('card-123', {
52
+ * scrollable: scrollContainerElement,
53
+ * behavior: 'smooth',
54
+ * topOffset: 80,
55
+ * ignoreWhenInView: 'top'
56
+ * });
57
+ * ```
58
+ */
59
+ scroll(anchor: string, options?: ScrollOptions): boolean;
60
+ static ɵfac: i0.ɵɵFactoryDeclaration<ScrollService, never>;
61
+ static ɵprov: i0.ɵɵInjectableDeclaration<any>;
62
+ }
63
+ /** Defaults for an application or overrides for one `magicScroll` region. */
64
+ interface MagicScrollOptions {
65
+ /** All descendant IDs participate when empty. Explicit `scrollAnchor`s also participate. */
66
+ anchorPrefix?: string;
67
+ /** Selector for a fixed/sticky header whose height is measured automatically. */
68
+ headerSelector?: string;
69
+ /** Gap below the header, or the complete top offset when no header is selected. */
70
+ headerOffset?: number;
71
+ /** Bottom offset in pixels to adjust the active reading boundary from the bottom. */
72
+ bottomOffset?: number;
73
+ /** Relative activation threshold (0.0 to 1.0) defining the trigger line within the visible reading area. */
74
+ activationThreshold?: number;
75
+ /** Restoration and deliberate user navigation have separate defaults. */
76
+ behavior?: {
77
+ restoration?: ScrollBehavior;
78
+ interaction?: ScrollBehavior;
79
+ };
80
+ debounceTime?: number;
81
+ ignoreWhenInView?: ScrollOptions['ignoreWhenInView'];
82
+ /** Keep the current anchor visible after later data updates. Defaults to true. */
83
+ restoreOnDataChange?: boolean;
84
+ /** Preserve the current anchor on window resize and measured header-height changes. */
85
+ preserveOnResize?: boolean;
86
+ }
87
+ interface ResolvedMagicScrollOptions {
88
+ anchorPrefix: string;
89
+ headerSelector: string;
90
+ headerOffset: number;
91
+ bottomOffset: number;
92
+ activationThreshold: number;
93
+ behavior: {
94
+ restoration: ScrollBehavior;
95
+ interaction: ScrollBehavior;
96
+ };
97
+ debounceTime: number;
98
+ ignoreWhenInView: NonNullable<ScrollOptions['ignoreWhenInView']>;
99
+ restoreOnDataChange: boolean;
100
+ preserveOnResize: boolean;
101
+ }
102
+ declare function resolveMagicScrollOptions(parent: ResolvedMagicScrollOptions, options: MagicScrollOptions): ResolvedMagicScrollOptions;
103
+ declare const MAGIC_SCROLL_OPTIONS: InjectionToken<ResolvedMagicScrollOptions>;
104
+ /**
105
+ * Register defaults globally or on a component. Child providers inherit unspecified options.
106
+ * Per-region `scrollOptions` and per-call `scrollTo` options take precedence.
107
+ *
108
+ * @example
109
+ * provideMagicScroll({ anchorPrefix: 'project-', behavior: { interaction: 'smooth' } })
110
+ */
111
+ export declare function provideMagicScroll(options?: MagicScrollOptions): Provider;
112
+ /** Reactive getters must read signals so loading and data changes are tracked.
113
+ * rxResource: { data: () => resource.value(), isLoading: resource.isLoading }.
114
+ * TanStack results already satisfy this contract. Supabase results can be stored in signals.
115
+ */
116
+ interface ScrollDataSource {
117
+ readonly data: () => unknown;
118
+ readonly isLoading: () => boolean;
119
+ }
120
+ /** Structural Angular resource contract; no dependency on a data-fetching provider. */
121
+ interface ScrollResource {
122
+ readonly value: () => unknown;
123
+ readonly isLoading: () => boolean;
124
+ readonly hasValue?: () => boolean;
125
+ }
126
+ /**
127
+ * Pass a signal (also computed/input/model signals), a resource/rxResource, or
128
+ * reactive data()/isLoading() getters. Plain input values are supported too.
129
+ * For signal forms pass the field's value signal, e.g. `form().value`.
130
+ * Supabase data and loading signals can use the neutral ScrollDataSource contract.
131
+ */
132
+ type ScrollSource = Signal<unknown> | ScrollResource | ScrollDataSource | object | string | number | boolean | null | undefined;
133
+ declare const NO_SCROLL_SOURCE: unique symbol;
134
+ /** Internal readiness adapter. null/undefined wait; [], 0, false and '' are ready. */
135
+ declare function readScrollSource(source: ScrollSource | typeof NO_SCROLL_SOURCE): {
136
+ ready: boolean;
137
+ data: unknown;
138
+ };
139
+ /**
140
+ * Per-action scroll options for programmatic navigation via {@link MagicScrollDirective.scrollTo}.
141
+ * Top offsets and container scoping are resolved automatically by the directive facade.
142
+ */
143
+ type MagicScrollToOptions = Pick<ScrollOptions, 'behavior' | 'topOffset' | 'ignoreWhenInView'>;
144
+ /**
145
+ * Complete facade directive coordinating anchor scrolling, two-tier route synchronization,
146
+ * user-intent cancellation, data readiness restoration, and layout/data position preservation.
147
+ *
148
+ * @remarks
149
+ * ### Architectural Pillars:
150
+ * 1. **Two-Tier Anchor State Model**:
151
+ * - `liveAnchor`: Immediate per-scroll evaluation representing the visible section currently in view.
152
+ * Used as the source of truth for immediate data and layout realignments.
153
+ * - `fragment` / `activeAnchor`: Debounced (default 500ms) URL router synchronization preventing browser
154
+ * history thrashing during continuous scrolling.
155
+ * 2. **User Intent Detection & Cancellation**:
156
+ * - Captures manual user gestures (`wheel`, `touchstart`, `touchmove`, navigation `keydown`) occurring prior
157
+ * to asynchronous `scrollSource` readiness.
158
+ * - Invalidates pending delayed initial restorations so conscious user navigation is never overridden.
159
+ * - Safely excludes editable form controls (`<input>`, `<textarea>`, `contenteditable`).
160
+ * 3. **Reactive Render Pipeline & Lifecycle Coordination**:
161
+ * - Sequenced `afterRenderEffect` execution blocks guarantee sticky header measurement and `ResizeObserver`
162
+ * monitoring are active before initial fragment restoration and data preservation execute.
163
+ * 4. **Preservation & Realignment Engine**:
164
+ * - Automatic realignments (`preserve('top')`) on data updates and container/header resizes based on the live active section.
165
+ * 5. **Container & Anchor Scoping**:
166
+ * - Automatic scroll container resolution (window vs scrollable element) and hierarchical anchor ownership isolation.
167
+ *
168
+ * @example
169
+ * ```html
170
+ * <div magicScroll #scroll="magicScroll" [scrollSource]="projects">
171
+ * <section id="project-1">...</section>
172
+ * <section id="project-2">...</section>
173
+ * </div>
174
+ * <button (click)="scroll.scrollTo('project-2')">Go to Project 2</button>
175
+ * ```
176
+ */
177
+ export declare class MagicScrollDirective {
178
+ /**
179
+ * Asynchronous data source or signal determining scroll readiness.
180
+ * - When omitted (`NO_SCROLL_SOURCE`), initial restoration executes on the initial rendered DOM.
181
+ * - When provided, initial restoration waits until `readScrollSource(source).ready === true`.
182
+ * Subsequent ready data updates trigger automatic position preservation when `restoreOnDataChange` is enabled.
183
+ */
184
+ readonly scrollSource: import("@angular/core").InputSignalWithTransform<ScrollSource | typeof NO_SCROLL_SOURCE, ScrollSource>;
185
+ /** Configuration overrides merged with global `provideMagicScroll` options. */
186
+ readonly scrollOptions: import("@angular/core").InputSignal<MagicScrollOptions>;
187
+ private readonly defaults;
188
+ private readonly options;
189
+ private readonly document;
190
+ private readonly host;
191
+ private readonly service;
192
+ private readonly nearest;
193
+ /** Bidirectional route fragment synchronization signal (debounced URL writer and listener). */
194
+ private readonly fragment;
195
+ /** Initial route URL fragment snapshot captured upon directive instantiation. */
196
+ private readonly initialAnchor;
197
+ /** Dynamically measured header height via ResizeObserver. */
198
+ private readonly measuredHeaderHeight;
199
+ /**
200
+ * Real-time visible section identifier updated per scroll event.
201
+ * Serves as the source of truth for immediate data and layout realignments (`preserve`),
202
+ * decoupling preservation from the debounced URL fragment signal.
203
+ */
204
+ private readonly liveAnchor;
205
+ /** Current URL anchor, suitable for active-navigation highlighting. */
206
+ readonly activeAnchor: import("@angular/core").Signal<string | null | undefined>;
207
+ /** Measured header height, useful for sticky companion panels. */
208
+ readonly headerHeight: import("@angular/core").Signal<number>;
209
+ /** Complete effective top offset, including header height and configured gap. */
210
+ readonly offset: import("@angular/core").Signal<number>;
211
+ /** Monotonically increasing revision counter triggering debounced URL fragment updates. */
212
+ private readonly scrollRevision;
213
+ /** Flag indicating whether the initial restoration phase has been executed. */
214
+ private initialized;
215
+ /**
216
+ * Flag indicating whether manual user interaction (wheel, touch, or navigation keys) occurred
217
+ * before asynchronous data loading became ready. When true, delayed initial restoration is skipped.
218
+ */
219
+ private userInterrupted;
220
+ private target?;
221
+ private timer?;
222
+ constructor();
223
+ /**
224
+ * Explicitly scrolls the viewport to the target anchor identifier.
225
+ *
226
+ * @param anchor - Target anchor ID (with or without leading `#`).
227
+ * @param options - Per-call scroll overrides (behavior, top offset, ignoreWhenInView).
228
+ * @returns `true` if the target anchor was found and scrolling initiated; `false` otherwise.
229
+ *
230
+ * @remarks
231
+ * Successful execution immediately synchronizes both `liveAnchor` and the router `fragment`
232
+ * with the target anchor, overriding any in-flight debounce delays.
233
+ */
234
+ scrollTo(anchor: string, options?: MagicScrollToOptions): boolean;
235
+ /**
236
+ * Queries and returns all eligible scroll anchor elements belonging strictly to this directive instance.
237
+ *
238
+ * @remarks
239
+ * Anchors must possess a non-empty `id` and either match the configured `anchorPrefix` or contain
240
+ * the `data-scroll-anchor` attribute. The `closest('[magicScroll]') === this.host` check prevents
241
+ * nested or parent `magicScroll` directive instances from capturing child anchors across boundaries.
242
+ */
243
+ private anchors;
244
+ /**
245
+ * Resolves the active scroll container element governing viewport offsets.
246
+ *
247
+ * @returns The scrollable container `HTMLElement`, or `undefined` when scrolling against the document root / window.
248
+ */
249
+ private scrollable;
250
+ /**
251
+ * Computes the nearest visible anchor according to current viewport geometry, header offsets,
252
+ * bottom offsets, and reading direction thresholds.
253
+ */
254
+ private calculateNearestAnchor;
255
+ /**
256
+ * Dispatches scrolling to the underlying {@link ScrollService} after validating target presence.
257
+ */
258
+ private execute;
259
+ /**
260
+ * Realigns the viewport instantly to preserve position during asynchronous data updates
261
+ * or container / header dimension changes.
262
+ *
263
+ * @remarks
264
+ * Targets `liveAnchor` (the real-time visible section) rather than `fragment` (the debounced URL fragment)
265
+ * to ensure rapid data or layout shifts during continuous scrolling maintain the user's active view
266
+ * rather than jumping back to a stale URL anchor.
267
+ */
268
+ private preserve;
269
+ /**
270
+ * Updates target container references and re-binds passive event listeners whenever
271
+ * the scroll container shifts dynamically.
272
+ */
273
+ private refreshTarget;
274
+ /**
275
+ * Attaches passive scroll, gesture, and keyboard listeners to track user intent and scroll motion.
276
+ */
277
+ private attachListeners;
278
+ /**
279
+ * Detaches all registered event listeners to ensure clean teardown without memory leaks.
280
+ */
281
+ private detachListeners;
282
+ /**
283
+ * Intercepts manual user gestures (`wheel`, `touchstart`, `touchmove`) to flag user interaction
284
+ * and cancel delayed initial restorations prior to data readiness.
285
+ */
286
+ private readonly onUserIntent;
287
+ /**
288
+ * Intercepts navigation keyboard events (`ArrowUp`, `ArrowDown`, `PageUp`, `PageDown`, `Home`, `End`, `Space`).
289
+ * Cancels pending initial restoration when navigation occurs within the relevant scroll context
290
+ * while safely ignoring interactions on editable input elements.
291
+ */
292
+ private readonly onKeyDown;
293
+ /**
294
+ * Handles scroll events by immediately updating `liveAnchor` for position preservation,
295
+ * while debouncing `scrollRevision` increments to update the browser URL fragment without thrashing history.
296
+ */
297
+ private readonly onScroll;
298
+ /**
299
+ * Handles window resize events by re-evaluating targets and optionally realigning the active anchor.
300
+ */
301
+ private readonly onResize;
302
+ static ɵfac: i0.ɵɵFactoryDeclaration<MagicScrollDirective, never>;
303
+ static ɵdir: i0.ɵɵDirectiveDeclaration<MagicScrollDirective, "[magicScroll]", ["magicScroll"], {
304
+ "scrollSource": {
305
+ "alias": "scrollSource";
306
+ "required": false;
307
+ "isSignal": true;
308
+ };
309
+ "scrollOptions": {
310
+ "alias": "scrollOptions";
311
+ "required": false;
312
+ "isSignal": true;
313
+ };
314
+ }, {}, never, never, true, never>;
315
+ }
316
+ /**
317
+ * Optional explicit anchor. Its ID participates even outside the configured prefix.
318
+ * Use `scrollAnchor` alongside an existing id, or `[scrollAnchor]="item.id"` to set it.
319
+ */
320
+ export declare class ScrollAnchorDirective {
321
+ readonly scrollAnchor: import("@angular/core").InputSignal<string>;
322
+ private readonly host;
323
+ constructor();
324
+ static ɵfac: i0.ɵɵFactoryDeclaration<ScrollAnchorDirective, never>;
325
+ static ɵdir: i0.ɵɵDirectiveDeclaration<ScrollAnchorDirective, "[scrollAnchor]", never, {
326
+ "scrollAnchor": {
327
+ "alias": "scrollAnchor";
328
+ "required": false;
329
+ "isSignal": true;
330
+ };
331
+ }, {}, never, never, true, never>;
332
+ }
333
+ export type { MagicScrollOptions, MagicScrollToOptions, ScrollDataSource, ScrollResource, ScrollSource };