Router Signal Store

@ngworker/router-signal-store

A strictly typed lightweight alternative to NgRx Router Store (@ngrx/router-store) and ActivatedRoute using NgRx Signals (@ngrx/signals).

Compatibility

Required peer dependencies:

• Angular 17.x
• NgRx Signals 17.x
• TypeScript >=5.2

Published with partial Ivy compilation.

Find additional documentation in the github.com/ngworker/router-component-store/docs directory.

Guiding principles

Router Signal Store is meant as a lightweight alternative to NgRx Router Store that additionally can be used as a replacement for ActivatedRoute at any route level.

The following principles guide the development of Router Signal Store.

• Global router store signals closely matches NgRx Router Store selectors
• Local router store signals closely match ActivatedRoute observable properties
• Router state is immutable and serializable
• The API is strictly and strongly typed

API

RouterSignalStore

A RouterSignalStore service has the following public properties.

A RouterSignalStore service is provided by using either provideGlobalRouterSignalStoreor provideLocalRouterSignalStore.

The global RouterSignalStore service is provided in a root environment injector and is never destroyed but can be injected in any injection context.

It emits values similar to @ngrx/router-store selectors. A comparison is in the documentation.

A local RouterSignalStore requires a component-level provider, follows the lifecycle of that component, and can be injected in declarables as well as other component-level services.

It emits values similar to ActivatedRoute. A comparison is in the documentation.

Global router signal store

An application-wide router signal store that can be injected in any injection context. Use provideGlobalRouterSignalStore to provide it in a root environment injector.

Use a global router signal store instead of NgRx Router Store.

Providing in a standalone Angular application:

// main.ts
// (...)
import { provideGlobalRouterSignalStore } from '@ngworker/router-signal-store';

bootstrapApplication(AppComponent, {
  providers: [provideGlobalRouterSignalStore()],
}).catch((error) => console.error(error));

Providing in a classic Angular application:

// app.module.ts
// (...)
import { provideGlobalRouterSignalStore } from '@ngworker/router-signal-store';

@NgModule({
  // (...)
  providers: [provideGlobalRouterSignalStore()],
})
export class AppModule {}

Usage in service:

// hero.service.ts
// (...)
import { RouterSignalStore } from '@ngworker/router-signal-store';

@Injectable({
  providedIn: 'root',
})
export class HeroService {
  #routerSignalStore = inject(RouterSignalStore);

  activeHeroId: Signal<string | undefined> = this.#routerSignalStore.selectRouteParam('id');
}

Usage in component:

// hero-detail.component.ts
// (...)
import { RouterSignalStore } from '@ngworker/router-signal-store';

@Component({
  // (...)
})
export class HeroDetailComponent {
  #routerSignalStore = inject(RouterSignalStore);

  heroId: Signal<string | undefined> = this.#routerSignalStore.selectRouteParam('id');
}

Local router signal store

A component-level router signal store. Can be injected in any directive, component, pipe, or component-level service. Explicitly provided in a component sub-tree using Component.providers or Component.viewProviders.

Use a local router signal store instead of ActivatedRoute.

Usage in component:

// hero-detail.component.ts
// (...)
import { provideLocalRouterSignalStore, RouterSignalStore } from '@ngworker/router-signal-store';

@Component({
  // (...)
  providers: [provideLocalRouterSignalStore()],
})
export class HeroDetailComponent {
  #routerSignalStore = inject(RouterSignalStore);

  heroId: Signal<string | undefined> = this.#routerSignalStore.selectRouteParam('id');
}

Serializable router state

Several of the Angular Router's types are recursive which means that they aren't serializable. The router stores exclusively use serializable types to support advanced state synchronization strategies.

MinimalActivatedRouteSnapshot

The MinimalActivatedRouteSnapshot interface is used for the observable RouterSignalStore#currentRoute property. This interface is a serializable subset of the Angular Router's ActivatedRouteSnapshot class and has the following public properties.

StrictQueryParams

The StrictQueryParams type is used for query parameters in the MinimalActivatedRouteSnapshot#queryParams and RouterSignalStore#queryParams properties. It is a strictly typed version of the Angular Router's Params type where members are read-only and the any member type is replaced with string | readonly string[] | undefined.

StrictQueryParams has the following signature.

export type StrictQueryParams = {
  readonly [key: string]: string | readonly string[] | undefined;
};

StrictRouteData

The StrictRouteData interface is used for the MinimalActivatedRouteSnapshot#data and RouterSignalStore#routeData properties. This interface is a serializable subset of the Angular Router's Data type. In particular, the symbol index in the Angular Router's Data type is removed. Additionally, the any member type is replaced with unknown for stricter typing.

StrictRouteData has the following signature.

export type StrictRouteData = {
  readonly [key: string]: unknown;
};

StrictRouteParams

The StrictRouteParams type is used for route parameters in the MinimalActivatedRouteSnapshot#params and RouterSignalStore#routeParams properties. It is a strictly typed version of the Angular Router's Params type where members are read-only and the any member type is replaced with string | undefined.

StrictRouteParams has the following signature.

export type StrictRouteParams = {
  readonly [key: string]: string | undefined;
};