angular-router-menus

Angular Router Menus

Simplify your Angular applications navigation by defining menu entries directly at the route itself. It is fully typed and defined by your requirements, build as many navigation's as you like. It also supports nesting menus so you can build yourself cool dropdowns. All menus are build and injected into several injection tokens, so you can import them anywhere.

pnpm add angular-router-menus

[!TIP] Zero dependencies and no performance bottleneck!

• Installation
  • menus.ts
  • main.ts
• Usage
• Configuration
• Examples

Installation

• Install the package
• Add these entries to your tsconfig.json of your application
  • angular-router-menus: This ensures you have all required types globally
  • angular-router-menus/angular: This patches Angular's Route(r) type with a new entry
• Create a type definition file and add this line
  • declare type Menus = "main"
  • Adjust menus by your needs, you will configure them later
• Create a menus.ts file, this will hold your Menus stack injection tokens
• In your main.ts file import and configure the library as described below

menus.ts

import { InjectionToken, type WritableSignal, signal } from "@angular/core";

import type { MenuItems, MenuStacks } from "angular-router-menus";

export const MENU_STACK = new InjectionToken<WritableSignal<MenuItems>>("MENU_STACK", {
	providedIn: "root",
	factory: () => signal([]),
});

export const menus: MenuStacks = {
	main: MENU_STACK,
};

main.ts

import { bootstrapApplication } from "@angular/platform-browser";
import { provideRouter, withComponentInputBinding } from "@angular/router";

import { provideRouterMenus } from "angular-router-menus";

import { AppComponent } from "./app/app.component";
import { menus } from "./menus";
import { routes } from "./routes";

void bootstrapApplication(AppComponent, {
	providers: [
		provideRouter(routes, withComponentInputBinding()),
		provideRouterMenus(routes, menus, {
			defaultMenu: "main", // 👋🏻
		}),
	],
}).catch((error) => {
	console.error(error);
});

Usage

import { ChangeDetectionStrategy, Component, inject } from "@angular/core";
import { RouterLink, RouterLinkActive, RouterOutlet } from "@angular/router";

import { MENU_STACK } from "../menus";

@Component({
	selector: "app-root",
	templateUrl: "./app.component.html",
	styleUrl: "./app.component.scss",
	changeDetection: ChangeDetectionStrategy.OnPush,
	imports: [RouterOutlet, RouterLink, RouterLinkActive],
})
export class AppComponent {
	readonly menu = inject(MENU_STACK); // 👋🏻
}

<ul>
	@for (item of menu(); track item.href) {
	<li>
		<a [routerLink]="item.href" routerLinkActive="active">{{ item.label }}</a>
	</li>
	}
</ul>

Configuration

For details on menu items configuration, please take a look at the interfaces and its documentation here: projects/angular-router-menus/src/lib/menu.ts

Property	Description
defaultMenu	If not defined via in this is the default menu.

Examples

For an example go to projects/app and run it :)