Skip to content

evanmonfee/ngx-circular-menu-demo

Repository files navigation

NgxCircularMenu

ngx-circular-menu: Add unique circular menus to your application, similar to the Floating Action Button (FAB) in android. You can add 4 menu items to this menu.

Radial Menu

enter image description here

Installation

1. NPM Installation

Now install ngx-circular-menu via npm:

npm info ngx-circular-menu

2. Import the library

Once installed you need to import the main module:

import { NgxCircularMenuModule } from  'ngx-circular-menu'; <---

 @NgModule({
    declarations: [
    AppComponent,
    ],
    imports: [
    BrowserModule,
    AppRoutingModule,
    NgxCircularMenuModule, <----
    ],
    providers: [],
    bootstrap: [AppComponent]
    })
    export  class AppModule { }

Usage

1. In the .html file:

    <lib-ngx-circular-menu  
      [menuItemsModelData]='menuItemsModel'  
      (menuItemOneClick)='goToDashboard()' 
      (menuItemTwoClick)='goToSearch()' 
      (menuItemThreeClick)='goToWishlist()' 
      (menuItemFourClick)='goToLogout()'>
    </lib-ngx-circular-menu>

2. In the .ts file:

    menuItemsModel: MenuItemsModel;

    setRadialMenu() {
      this.menuItemsModel = new MenuItemsModel(
      "Dashboard", 'assets/icons/icn_drawdowns.svg',
      "Search", 'assets/icons/icn_search_white.svg',
      "Wishlist", 'assets/icons/icn_to-do-list.svg',
      "Logout", 'assets/icons/logout.svg'
     );
    }

3. Sample component: app-component.html

    <lib-ngx-circular-menu  
      [menuItemsModelData]='menuItemsModel'  
      (menuItemOneClick)='goToDashboard()' 
      (menuItemTwoClick)='goToSearch()' 
      (menuItemThreeClick)='goToWishlist()' 
      (menuItemFourClick)='goToLogout()'>
    </lib-ngx-circular-menu>

app-component.ts

export class AppComponent implements OnInit{

title = 'radial-menu';
menuItemsModel: MenuItemsModel;

ngOnInit(){
this.setRadialMenu();
}

setRadialMenu() {
this.menuItemsModel = new MenuItemsModel(
"Dashboard", 'assets/icons/icn_drawdowns.svg',
"Search", 'assets/icons/icn_search_white.svg',
"Wishlist", 'assets/icons/icn_to-do-list.svg',
"Logout", 'assets/icons/logout.svg'
);
}

goToDashboard() {
console.log('goToDashboard clicked..');
}

goToSearch() {
console.log('goToSearch clicked..');
}

goToWishlist() {
console.log('goToWishlist clicked..');
}

goToLogout() {
console.log('goToLogout clicked..');
}

}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published