feat(router): Make match options optional in isActive

atscott · leonsenft · commit cf9620f7d072 · 2026-01-29T12:10:40.000-08:00
The behavior now matches RouterLinkActive.
diff --git a/goldens/public-api/router/index.api.md b/goldens/public-api/router/index.api.md
@@ -370,7 +370,7 @@ export interface InMemoryScrollingOptions {
 }
 
 // @public
-export function isActive(url: string | UrlTree, router: Router, matchOptions: IsActiveMatchOptions): Signal<boolean>;
+export function isActive(url: string | UrlTree, router: Router, matchOptions?: IsActiveMatchOptions): Signal<boolean>;
 
 // @public
 export interface IsActiveMatchOptions {
diff --git a/packages/router/src/directives/router_link_active.ts b/packages/router/src/directives/router_link_active.ts
@@ -27,8 +27,8 @@ import {from, of, Subscription} from 'rxjs';
 import {mergeAll} from 'rxjs/operators';
 
 import {Event, NavigationEnd} from '../events';
-import {exactMatchOptions, Router, subsetMatchOptions} from '../router';
-import {isActive, IsActiveMatchOptions} from '../url_tree';
+import {Router} from '../router';
+import {isActive, IsActiveMatchOptions, exactMatchOptions, subsetMatchOptions} from '../url_tree';
 
 import {RouterLink} from './router_link';
 
diff --git a/packages/router/src/router.ts b/packages/router/src/router.ts
@@ -59,8 +59,10 @@ import {StateManager} from './statemanager/state_manager';
 import {UrlHandlingStrategy} from './url_handling_strategy';
 import {
   containsTree,
+  exactMatchOptions,
   IsActiveMatchOptions,
   isUrlTree,
+  subsetMatchOptions,
   UrlSegmentGroup,
   UrlSerializer,
   UrlTree,
@@ -69,28 +71,6 @@ import {validateConfig} from './utils/config';
 import {afterNextNavigation} from './utils/navigations';
 import {RouterState} from './router_state';
 
-/**
- * The equivalent `IsActiveMatchOptions` options for `isActive` is called with `true`
- * (exact = true).
- */
-export const exactMatchOptions: IsActiveMatchOptions = {
-  paths: 'exact',
-  fragment: 'ignored',
-  matrixParams: 'ignored',
-  queryParams: 'exact',
-};
-
-/**
- * The equivalent `IsActiveMatchOptions` options for `isActive` is called with `false`
- * (exact = false).
- */
-export const subsetMatchOptions: IsActiveMatchOptions = {
-  paths: 'subset',
-  fragment: 'ignored',
-  matrixParams: 'ignored',
-  queryParams: 'subset',
-};
-
 /**
  * @description
  *
diff --git a/packages/router/src/url_tree.ts b/packages/router/src/url_tree.ts
@@ -80,6 +80,28 @@ const paramCompareMap: Record<ParamMatchOptions, ParamCompareFn> = {
   'ignored': () => true,
 };
 
+/**
+ * The equivalent `IsActiveMatchOptions` options for `isActive` is called with `true`
+ * (exact = true).
+ */
+export const exactMatchOptions: IsActiveMatchOptions = {
+  paths: 'exact',
+  fragment: 'ignored',
+  matrixParams: 'ignored',
+  queryParams: 'exact',
+};
+
+/**
+ * The equivalent `IsActiveMatchOptions` options for `isActive` is called with `false`
+ * (exact = false).
+ */
+export const subsetMatchOptions: IsActiveMatchOptions = {
+  paths: 'subset',
+  fragment: 'ignored',
+  matrixParams: 'ignored',
+  queryParams: 'subset',
+};
+
 /**
  * Returns a computed signal of whether the given url is activated in the Router.
  *
@@ -91,14 +113,14 @@ const paramCompareMap: Record<ParamMatchOptions, ParamCompareFn> = {
 export function isActive(
   url: string | UrlTree,
   router: Router,
-  matchOptions: IsActiveMatchOptions,
+  matchOptions?: IsActiveMatchOptions,
 ): Signal<boolean> {
   const urlTree = url instanceof UrlTree ? url : router.parseUrl(url);
   return computed(() =>
     containsTree(
       router.lastSuccessfulNavigation()?.finalUrl ?? new UrlTree(),
       urlTree,
-      matchOptions,
+      matchOptions ?? subsetMatchOptions,
     ),
   );
 }
diff --git a/packages/router/test/url_tree.spec.ts b/packages/router/test/url_tree.spec.ts
@@ -7,8 +7,13 @@
  */
 
 import {TestBed} from '@angular/core/testing';
-import {exactMatchOptions, Router, subsetMatchOptions} from '../src/router';
-import {containsTree, DefaultUrlSerializer} from '../src/url_tree';
+import {Router} from '../src/router';
+import {
+  containsTree,
+  DefaultUrlSerializer,
+  exactMatchOptions,
+  subsetMatchOptions,
+} from '../src/url_tree';
 
 describe('UrlTree', () => {
   const serializer = new DefaultUrlSerializer();

Original file line number	Diff line number	Diff line change
`@@ -370,7 +370,7 @@ export interface InMemoryScrollingOptions {`
`370`	`370`	`}`
`371`	`371`
`372`	`372`	`// @public`
`373`		`-export function isActive(url: string \| UrlTree, router: Router, matchOptions: IsActiveMatchOptions): Signal<boolean>;`
	`373`	`+export function isActive(url: string \| UrlTree, router: Router, matchOptions?: IsActiveMatchOptions): Signal<boolean>;`
`374`	`374`
`375`	`375`	`// @public`
`376`	`376`	`export interface IsActiveMatchOptions {`