Overview

An angular 2 slide navigation menu component for mobile and web.Hamburger kind of menu for mobile and web is very common feature and a must have as well, these days.

An angular 2 slide navigation menu component for mobile and web. Hamburger kind of menu for mobile and web is very common feature and a must have as well, these days.

Getting Started

Installation

  • The Slide menu package is published on the npm Registry.
  • Install the package : npm install cuppa-ng2-slidemenu

  • Once installed import SlideMenuModule from the installed package into your module as follows:
import { SlideMenuModule } from 'cuppa-ng2-slidemenu/cuppa-ng2-slidemenu';

Basic Usage

  • Import the SlideMenuModule in your ngModule as follows:
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { SlideMenuModule } from 'cuppa-ng2-slidemenu/cuppa-ng2-slidemenu';
import { AppComponent } from './app.component';

@NgModule({
   bootstrap: [ AppComponent ],
   declarations: [AppComponent],
   imports: [SlideMenuModule] // Import SlideMenu module variable here 
})
export class AppModule {
}
  • Place the component html tag in the template where the hamburger menu needs to be rendered.
<cuppa-slidemenu [menulist]="menuItemsArray" (open)="onMenuOpen()" (close)="onMenuClose()" (onItemSelect)="onItemSelect($event)"></cuppa-slidemenu>
  • Component requires a menulist to pass data as array of objects to the component, as follows:
private menuItemsArray: any[] = [ 
       {"title":"Electricity","link":"#"},
       {"title":"Mobile Bill","link":"#"},
       {"title":"Home and Kitchen","link":"#",
       "subItems":[
                   {"title":"Furniture","link":"#"},
                   {"title":"Cookware","link":"#"},
                  ]
       },
       {"title":"Car and Bike Accessories","link":"#",
        "subItems":[
                     {"title":"Tyres and Alloys","link":"#"},
                     {"title":"Comfort and Safety","link":"#"},
                    ]
       },
 ];

  public onMenuClose(){
    console.log("menu closed");
  }
  public onMenuOpen(){
    console.log("menu Opened");
  }
  private onItemSelect(item:any){
    console.log(item);
  }

Thats all Folks !! You are good to go.

View the Demo here.

Please raise any issues here

To run the code and build in your local, follw the below steps

  • git clone https://github.com/CuppaLabs/cuppa-ng2-slidemenu.git
  • npm install
  • npm start
  • Go to http://localhost:3000 where your app will run.

Licence

This project is licensed under the MIT license. See the LICENSE file for more info.

The MIT License (MIT) Copyright (c) 2016 Cuppa Labs

Pradeep Terli

Web UI Developer, Blogger, Thinker , Entrepreneur. Loves to explore technology with focus on web technologies.