ngx-multi-level-push-menu

A modern, accessible Angular component for responsive multi-level push menus with extensive customization options.

Features

• Responsive multi-level push menu for Angular applications
• Accessibility-enhanced with ARIA attributes and keyboard navigation
• Endless nesting capability for navigation elements
• Left-to-right and Right-to-left sliding directions
• Customizable animation effects
• Two menu modes: overlap and cover
• Swipe gesture support (configurable for touch, desktop, or both)
• Router integration
• Comprehensive styling options
• Flexible icon support - use SVG content directly or CSS classes from any icon library
• Compatible with Angular 6+ through 19+

Installation

Install the package via npm:

npm install @ramiz4/ngx-multi-level-push-menu --save

Quick Start

1. Import the module in your application:

For NgModule-based applications:

import { NgxMultiLevelPushMenuModule } from '@ramiz4/ngx-multi-level-push-menu';

@NgModule({
  imports: [
    // ...other imports
    NgxMultiLevelPushMenuModule.forRoot(),
  ],
  // ...
})
export class AppModule {}

For standalone applications (Angular 14+):

// In app.config.ts or equivalent
import { ApplicationConfig } from '@angular/core';
import { provideMultiLevelPushMenu } from '@ramiz4/ngx-multi-level-push-menu';

export const appConfig: ApplicationConfig = {
  providers: [
    // ...other providers
    provideMultiLevelPushMenu(),
  ],
};

// In your component
import { Component } from '@angular/core';
import { MultiLevelPushMenuComponent } from '@ramiz4/ngx-multi-level-push-menu';

@Component({
  // ...
  standalone: true,
  imports: [MultiLevelPushMenuComponent],
})
export class AppComponent {
  // ...
}

2. Add the component to your template:

<ramiz4-multi-level-push-menu [options]="options">
  <router-outlet></router-outlet>
</ramiz4-multi-level-push-menu>

3. Define your menu structure in your component:

Option 1: Using SVG icons directly (recommended for best performance and no external dependencies)

import { Component, OnInit } from '@angular/core';
import { MultiLevelPushMenuService, MultiLevelPushMenuOptions } from '@ramiz4/ngx-multi-level-push-menu';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
})
export class AppComponent implements OnInit {
  options = new MultiLevelPushMenuOptions();

  constructor(private menuService: MultiLevelPushMenuService) {}

  ngOnInit() {
    this.options.title = 'Company Name'; // Set menu title

    // Menu items with SVG icons
    this.options.menu = [
      {
        name: 'Home',
        // SVG home icon
        icon: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M575.8 255.5c0 18-15 32.1-32 32.1h-32l.7 160.2c0 2.7-.2 5.4-.5 8.1V472c0 22.1-17.9 40-40 40H456c-1.1 0-2.2 0-3.3-.1c-1.4 .1-2.8 .1-4.2 .1H416 392c-22.1 0-40-17.9-40-40V448 384c0-17.7-14.3-32-32-32H256c-17.7 0-32 14.3-32 32v64 24c0 22.1-17.9 40-40 40H160 128.1c-1.5 0-3-.1-4.5-.2c-1.2 .1-2.4 .2-3.6 .2H104c-22.1 0-40-17.9-40-40V360c0-.9 0-1.9 .1-2.8V287.6H32c-18 0-32-14-32-32.1c0-9 3-17 10-24L266.4 8c7-7 15-8 22-8s15 2 21 7L564.8 231.5c8 7 12 15 11 24z"/></svg>',
        link: 'home',
      },
      // ...more menu items with SVG icons
    ];
  }
}

Option 2: Using CSS classes from an icon library (e.g., Font Awesome)

First, include the icon library in your project. For Font Awesome, add to your main styles.scss:

/* Import Font Awesome from CDN */
@import url('https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css');

/* Or if installed via npm */
/* @import '~@fortawesome/fontawesome-free/css/all.min.css'; */

Then define your menu with CSS classes as icons:

import { Component, OnInit } from '@angular/core';
import { MultiLevelPushMenuService, MultiLevelPushMenuOptions } from '@ramiz4/ngx-multi-level-push-menu';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
})
export class AppComponent implements OnInit {
  options = new MultiLevelPushMenuOptions();

  constructor(private menuService: MultiLevelPushMenuService) {}

  ngOnInit() {
    this.options.title = 'Company Name'; // Set menu title

    // Menu items with Font Awesome icons
    this.options.menu = [
      { name: 'Home', icon: 'fa fa-home', link: 'home' },
      { name: 'About Us', icon: 'fa fa-user', link: 'about-us' },
      {
        name: 'Devices',
        icon: 'fa fa-laptop',
        items: [
          {
            name: 'Mobile Phones',
            icon: 'fa fa-phone',
            // ...submenu items
          },
          // ...more submenu items
        ],
      },
      // ...more menu items
    ];
  }

  collapseMenu() {
    this.menuService.collapse();
  }

  expandMenu() {
    this.menuService.expand();
  }
}

Example Application

See the example application in the apps/multi-level-push-menu-example folder for a complete usage example.

To run the example:

ng serve multi-level-push-menu-example

Documentation

For detailed API documentation, configuration options, and advanced usage, see the library README in the libs/ngx-multi-level-push-menu directory.

Development

This project was generated using Nx.

Development server

Run ng serve multi-level-push-menu-example for a dev server. Navigate to http://localhost:4200/.

Build the library

Run ng build ngx-multi-level-push-menu to build the library.

Running unit tests

Run ng test ngx-multi-level-push-menu to execute the unit tests via Jest.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Development Workflow

Semantic Commit Messages

This project uses semantic commit messages to automate version bumping:

Commit Prefix	Description	Version Bump
feat:	A new feature	Minor version bump
fix:	A bug fix	Patch version bump
docs:	Documentation only changes	Patch version bump
BREAKING CHANGE:	Breaking changes	Major version bump

License

MIT © Ramiz Loki