@real-router/angular 0.9.0 → 0.11.0

package/src/internal/install.ts

@@ -1,9 +1,13 @@
 import { ApplicationRef, DestroyRef, inject } from "@angular/core";
 
-import { createScrollRestoration, createViewTransitions } from "../dom-utils";
+import {
+  createScrollRestoration,
+  createScrollSpy,
+  createViewTransitions,
+} from "../dom-utils";
 import { ROUTER } from "../providers";
 
-import type { ScrollRestorationOptions } from "../dom-utils";
+import type { ScrollRestorationOptions, ScrollSpyOptions } from "../dom-utils";
 
 /**
  * Shared installation helpers for `provideRealRouter` and
@@ -27,6 +31,15 @@ export function installScrollRestoration(
   });
 }
 
+export function installScrollSpy(options: ScrollSpyOptions): void {
+  const router = inject(ROUTER);
+  const spy = createScrollSpy(router, options);
+
+  inject(DestroyRef).onDestroy(() => {
+    spy.destroy();
+  });
+}
+
 export function installViewTransitions(): void {
   const router = inject(ROUTER);
 

package/src/providers.ts

@@ -9,11 +9,12 @@ import { createRouteSource } from "@real-router/sources";
 
 import {
   installScrollRestoration,
+  installScrollSpy,
   installViewTransitions,
 } from "./internal/install";
 import { sourceToSignal } from "./sourceToSignal";
 
-import type { ScrollRestorationOptions } from "./dom-utils";
+import type { ScrollRestorationOptions, ScrollSpyOptions } from "./dom-utils";
 import type { RouteSignals } from "./types";
 
 export const ROUTER = new InjectionToken<Router>("ROUTER");
@@ -24,6 +25,7 @@ export const ROUTE = new InjectionToken<RouteSignals>("ROUTE");
 
 export interface RealRouterOptions {
   scrollRestoration?: ScrollRestorationOptions;
+  scrollSpy?: ScrollSpyOptions;
   viewTransitions?: boolean;
 }
 
@@ -60,6 +62,16 @@ export function provideRealRouter(
     );
   }
 
+  if (options?.scrollSpy && options.scrollSpy.selector !== "") {
+    const spyOpts = options.scrollSpy;
+
+    providers.push(
+      provideEnvironmentInitializer(() => {
+        installScrollSpy(spyOpts);
+      }),
+    );
+  }
+
   if (options?.viewTransitions === true) {
     providers.push(provideEnvironmentInitializer(installViewTransitions));
   }

package/src/providersFactory.ts

@@ -21,12 +21,13 @@ import { createRouteSource } from "@real-router/sources";
 
 import {
   installScrollRestoration,
+  installScrollSpy,
   installViewTransitions,
 } from "./internal/install";
 import { NAVIGATOR, ROUTE, ROUTER } from "./providers";
 import { sourceToSignal } from "./sourceToSignal";
 
-import type { ScrollRestorationOptions } from "./dom-utils";
+import type { ScrollRestorationOptions, ScrollSpyOptions } from "./dom-utils";
 import type { RouteSignals } from "./types";
 
 /**
@@ -124,6 +125,9 @@ export interface RealRouterFactoryOptions<
   /** Optional scroll restoration — same semantics as `provideRealRouter`. */
   scrollRestoration?: ScrollRestorationOptions;
 
+  /** Optional scroll spy — same semantics as `provideRealRouter`. */
+  scrollSpy?: ScrollSpyOptions;
+
   /** Optional view transitions — same semantics as `provideRealRouter`. */
   viewTransitions?: boolean;
 }
@@ -156,8 +160,14 @@ export interface RealRouterFactoryOptions<
 export function provideRealRouterFactory<
   TDeps extends DefaultDependencies = DefaultDependencies,
 >(options: RealRouterFactoryOptions<TDeps>): EnvironmentProviders {
-  const { baseRouter, plugins, deps, scrollRestoration, viewTransitions } =
-    options;
+  const {
+    baseRouter,
+    plugins,
+    deps,
+    scrollRestoration,
+    scrollSpy,
+    viewTransitions,
+  } = options;
 
   const providers: Parameters<typeof makeEnvironmentProviders>[0] = [
     {
@@ -270,6 +280,14 @@ export function provideRealRouterFactory<
     );
   }
 
+  if (scrollSpy && scrollSpy.selector !== "") {
+    providers.push(
+      provideEnvironmentInitializer(() => {
+        installScrollSpy(scrollSpy);
+      }),
+    );
+  }
+
   if (viewTransitions === true) {
     providers.push(provideEnvironmentInitializer(installViewTransitions));
   }